the libs Reference - ZoomTen/theApp GitHub Wiki
(a.k.a theReference)
Full reference generated by Doxygen: theReference.pdf
tapplication.h (tApplication)
Inherits: QApplication
The base application class, basically a wrapper around QApplication to add some extra stuff the About dialog can display, and then some other stuff.
Function
• tApplication (int &argc, char ∗∗ argv)
Slots
• void registerCrashTrap ()
• static QStringList exportBacktrace ()
• static void setApplicationIcon (QIcon icon)
• static void setShareDir (QString shareDir)
• static void setGenericName (QString genericName)
• static void setAboutDialogSplashGraphic (QPixmap aboutDialogSplashGraphic)
• static void addLibraryVersion (QString libraryName, QString version)
• static void addCopyrightLine (QString copyrightLine)
• static void setCopyrightHolder (QString copyrightHolder)
• static void setCopyrightYear (QString copyrightYear)
• static void setApplicationLicense (KnownLicenses license)
• static QPixmap aboutDialogSplashGraphicFromSvg (QString svgFile) • void installTranslators ()
• static QString macOSBundlePath ()
• static void restart ()
Signals
• void openFile (QString file)
• void updateTranslators ()
tconditionalwidget.h (tConditionalWidget)
Inherits: QWidget
A simple widget that shows or hides depending on what state something is.
Functions
• tConditionalWidget (QWidget ∗ parent=nullptr)
• void expand ()
• void collapse ()
• void setExpanded (bool expanded)
tcsdtools.h (tCsdTools)
Inherits: QObject
A thing to bolt on client-side decoration (CSD) to an app. It can provide the app with a fine CSD widget to add to its collection.
Functions
• tCsdTools (QObject ∗ parent=nullptr)
• QWidget ∗ csdBoxForWidget (QWidget ∗ widget)
Slots
• void installMoveAction (QWidget ∗ widget)
• void removeMoveAction (QWidget ∗ widget)
• void installResizeAction (QWidget ∗ widget)
• void removeResizeAction (QWidget ∗ widget)
tstackedwidget.h (tStackedWidget)
Inherits: QStackedWidget
Allows you to implement pagination in an app with fancy animations and stuff.
Functions
• tStackedWidget (QWidget ∗ parent=nullptr)
• Animation CurrentAnimation ()
• int addWidget (QWidget ∗ w)
• int insertWidget (int index, QWidget ∗ w)
Slots
• void setCurrentIndex (int index, bool doAnimation=true)
• void setCurrentWidget (QWidget ∗ w, bool doAnimation=true)
• void setCurrentAnimation (Animation animation)
Signals
• void switchingFrame (int switchTo)
• void CurrentAnimationChanged (Animation currentAnimation)
• void resized ()
tswitch.h (tSwitch)
Inherits: QPushButton
A checkbox-like widget to provide some fancy-looking switches.
Functions
•tSwitch (QWidget ∗ parent=nullptr)
•QString OnText ()
•QString OffText ()
•QIcon OnIcon ()
•void setChecked (bool checked)
Slots
• void setOnText (QString text)
• void setOffText (QString text)
• void setOnIcon (QIcon icon)
Signals
• void OnTextChanged (QString OnText)
• void OffTextChanged (QString OffText)
• void OnIconChanged (QString OffText)
tsystemsound.h (tSystemSound)
Inherits: QObject
Adds some beeps, boops, bells, etc. to your app. Easy as pie to use, just play() a sound name that matches the freedesktop specs.
Functions
• static QString soundLocation (QString soundName)
• static bool isSoundEnabled (QString soundName)
• static void setSoundEnabled (QString soundName, bool isEnabled)
Slots
• static tSystemSound ∗ play (QString soundName)
• static tSystemSound ∗ play (QString soundName, qreal volume)
Signals
- void done ()
ttitlelabel.h (tTitleLabel)
Inherits: QLabel
Fancy schmancy heading label for all your titling needs.
Functions
-
tTitleLabel (QWidget ∗ parent=nullptr)
-
QSize sizeHint () const
-
bool backButtonShown ()
-
void setBackButtonShown (bool backButtonShown)
-
bool backButtonIsMenu ()
-
void setBackButtonIsMenu (bool backButtonIsMenu)
Signals
• void backButtonClicked ()
• void backButtonShownChanged (bool backButtonShown)
• void backButtonIsMenuChanged (bool backButtonIsMenu)
ttoast.h (tToast)
Inherits: QObject
Adds a bottom notification thingy (Android calls this a "toast"). You'd use it app-wide by using this.window().
Functions
-
tToast (QObject ∗ parent=0)
-
void setTitle (QString title)
-
QString title ()
-
void setText (QString text)
-
QString text ()
-
void setActions (QMap < QString, QString > actions)
-
QMap < QString, QString > actions ()
-
void setTimeout (int milliseconds)
-
int timeout ()
Slots
• void show (QWidget ∗ parent)
• void announceAction (QString text)
• void dismiss ()
Signals
• void actionClicked (QString key)
• void dismissed ()
• void doDefaultOption ()