A simple button for update checks. More...
#include <updatebutton.h>
Public Types | |
enum | ModeFlag { ModeFlag::ShowResult = 0x01, ModeFlag::ShowStatus = 0x02, ModeFlag::AllowInstall = 0x04, ModeFlag::AllowCancel = 0x08, ModeFlag::None = 0x00, ModeFlag::AllowAndShowAll = (ShowResult | ShowStatus | AllowInstall | AllowCancel) } |
Defines various flags to specify how the button should behave. More... | |
Public Slots | |
void | setUpdater (Updater *updater) |
WRITE accessor for UpdateButton::updater. | |
void | setMode (Mode mode) |
WRITE accessor for UpdateButton::mode. | |
void | setAnimationFile (const QString &animationFile, int speed=100) |
WRITE accessor for UpdateButton::animationFile. | |
void | setAnimationDevice (QIODevice *animationDevice, int speed=100) |
WRITE accessor for UpdateButton::animationFile. | |
void | resetAnimationFile () |
RESET accessor for UpdateButton::animationFile. | |
void | setInstallMode (QtAutoUpdater::Updater::InstallMode installMode) |
WRITE accessor for UpdateButton::installMode. | |
void | setInstallScope (QtAutoUpdater::Updater::InstallScope installScope) |
WRITE accessor for UpdateButton::installScope. | |
Signals | |
void | updaterChanged (QtAutoUpdater::Updater *updater, QPrivateSignal) |
NOTIFY accessor for UpdateButton::updater. | |
void | modeChanged (Mode mode, QPrivateSignal) |
NOTIFY accessor for UpdateButton::mode. | |
void | animationFileChanged (const QString &animationFile, QPrivateSignal) |
NOTIFY accessor for UpdateButton::animationFile. | |
void | installModeChanged (QtAutoUpdater::Updater::InstallMode installMode, QPrivateSignal) |
NOTIFY accessor for UpdateButton::installMode. | |
void | installScopeChanged (QtAutoUpdater::Updater::InstallScope installScope, QPrivateSignal) |
NOTIFY accessor for UpdateButton::installScope. | |
Public Member Functions | |
UpdateButton (QWidget *parent=nullptr) | |
Creates a new update button to place in your GUI. | |
UpdateButton (Updater *updater, QWidget *parent=nullptr) | |
Creates a new update button with an updater to place in your GUI. | |
Updater * | updater () const |
READ accessor for UpdateButton::updater. | |
Mode | mode () const |
READ accessor for UpdateButton::mode. | |
QString | animationFile () const |
READ accessor for UpdateButton::animationFile. | |
Updater::InstallMode | installMode () const |
READ accessor for UpdateButton::installMode. | |
Updater::InstallScope | installScope () const |
READ accessor for UpdateButton::installScope. | |
Public Member Functions inherited from QWidget | |
QWidget (QWidget *parent, Qt::WindowFlags f) | |
WId | winId () const const |
WId | effectiveWinId () const const |
QStyle * | style () const const |
void | setStyle (QStyle *style) |
bool | isTopLevel () const const |
bool | isWindow () const const |
bool | isModal () const const |
Qt::WindowModality | windowModality () const const |
void | setWindowModality (Qt::WindowModality windowModality) |
bool | isEnabled () const const |
bool | isEnabledTo (const QWidget *ancestor) const const |
bool | isEnabledToTLW () const const |
void | setEnabled (bool) |
void | setDisabled (bool disable) |
void | setWindowModified (bool) |
QRect | frameGeometry () const const |
const QRect & | geometry () const const |
QRect | normalGeometry () const const |
int | x () const const |
int | y () const const |
QPoint | pos () const const |
QSize | frameSize () const const |
QSize | size () const const |
int | width () const const |
int | height () const const |
QRect | rect () const const |
QRect | childrenRect () const const |
QRegion | childrenRegion () const const |
QSize | minimumSize () const const |
QSize | maximumSize () const const |
int | minimumWidth () const const |
int | minimumHeight () const const |
int | maximumWidth () const const |
int | maximumHeight () const const |
void | setMinimumSize (const QSize &) |
void | setMinimumSize (int minw, int minh) |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
void | setMinimumWidth (int minw) |
void | setMinimumHeight (int minh) |
void | setMaximumWidth (int maxw) |
void | setMaximumHeight (int maxh) |
void | setupUi (QWidget *widget) |
QSize | sizeIncrement () const const |
void | setSizeIncrement (const QSize &) |
void | setSizeIncrement (int w, int h) |
QSize | baseSize () const const |
void | setBaseSize (const QSize &) |
void | setBaseSize (int basew, int baseh) |
void | setFixedSize (const QSize &s) |
void | setFixedSize (int w, int h) |
void | setFixedWidth (int w) |
void | setFixedHeight (int h) |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPoint | mapToParent (const QPoint &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapFrom (const QWidget *parent, const QPoint &pos) const const |
QWidget * | window () const const |
QWidget * | nativeParentWidget () const const |
QWidget * | topLevelWidget () const const |
const QPalette & | palette () const const |
void | setPalette (const QPalette &) |
void | setBackgroundRole (QPalette::ColorRole role) |
QPalette::ColorRole | backgroundRole () const const |
void | setForegroundRole (QPalette::ColorRole role) |
QPalette::ColorRole | foregroundRole () const const |
const QFont & | font () const const |
void | setFont (const QFont &) |
QFontMetrics | fontMetrics () const const |
QFontInfo | fontInfo () const const |
QCursor | cursor () const const |
void | setCursor (const QCursor &) |
void | unsetCursor () |
void | setMouseTracking (bool enable) |
bool | hasMouseTracking () const const |
bool | underMouse () const const |
void | setTabletTracking (bool enable) |
bool | hasTabletTracking () const const |
void | setMask (const QBitmap &bitmap) |
void | setMask (const QRegion ®ion) |
QRegion | mask () const const |
void | clearMask () |
void | render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
QPixmap | grab (const QRect &rectangle) |
QGraphicsEffect * | graphicsEffect () const const |
void | setGraphicsEffect (QGraphicsEffect *effect) |
void | grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags) |
void | ungrabGesture (Qt::GestureType gesture) |
void | setWindowTitle (const QString &) |
void | setStyleSheet (const QString &styleSheet) |
QString | styleSheet () const const |
QString | windowTitle () const const |
void | setWindowIcon (const QIcon &icon) |
QIcon | windowIcon () const const |
void | setWindowIconText (const QString &) |
QString | windowIconText () const const |
void | setWindowRole (const QString &role) |
QString | windowRole () const const |
void | setWindowFilePath (const QString &filePath) |
QString | windowFilePath () const const |
void | setWindowOpacity (qreal level) |
qreal | windowOpacity () const const |
bool | isWindowModified () const const |
void | setToolTip (const QString &) |
QString | toolTip () const const |
void | setToolTipDuration (int msec) |
int | toolTipDuration () const const |
void | setStatusTip (const QString &) |
QString | statusTip () const const |
void | setWhatsThis (const QString &) |
QString | whatsThis () const const |
QString | accessibleName () const const |
void | setAccessibleName (const QString &name) |
QString | accessibleDescription () const const |
void | setAccessibleDescription (const QString &description) |
void | setLayoutDirection (Qt::LayoutDirection direction) |
Qt::LayoutDirection | layoutDirection () const const |
void | unsetLayoutDirection () |
void | setLocale (const QLocale &locale) |
QLocale | locale () const const |
void | unsetLocale () |
void | setFocus () |
bool | isActiveWindow () const const |
void | activateWindow () |
void | clearFocus () |
void | setFocus (Qt::FocusReason reason) |
Qt::FocusPolicy | focusPolicy () const const |
void | setFocusPolicy (Qt::FocusPolicy policy) |
bool | hasFocus () const const |
void | setFocusProxy (QWidget *w) |
QWidget * | focusProxy () const const |
Qt::ContextMenuPolicy | contextMenuPolicy () const const |
void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
void | grabMouse () |
void | grabMouse (const QCursor &cursor) |
void | releaseMouse () |
void | grabKeyboard () |
void | releaseKeyboard () |
int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context) |
void | releaseShortcut (int id) |
void | setShortcutEnabled (int id, bool enable) |
void | setShortcutAutoRepeat (int id, bool enable) |
bool | updatesEnabled () const const |
void | setUpdatesEnabled (bool enable) |
QGraphicsProxyWidget * | graphicsProxyWidget () const const |
void | update () |
void | repaint () |
void | update (int x, int y, int w, int h) |
void | update (const QRect &rect) |
void | update (const QRegion &rgn) |
void | repaint (int x, int y, int w, int h) |
void | repaint (const QRect &rect) |
void | repaint (const QRegion &rgn) |
virtual void | setVisible (bool visible) |
void | setHidden (bool hidden) |
void | show () |
void | hide () |
void | showMinimized () |
void | showMaximized () |
void | showFullScreen () |
void | showNormal () |
bool | close () |
void | raise () |
void | lower () |
void | stackUnder (QWidget *w) |
void | move (int x, int y) |
void | move (const QPoint &) |
void | resize (int w, int h) |
void | resize (const QSize &) |
void | setGeometry (int x, int y, int w, int h) |
void | setGeometry (const QRect &) |
QByteArray | saveGeometry () const const |
bool | restoreGeometry (const QByteArray &geometry) |
void | adjustSize () |
bool | isVisible () const const |
bool | isVisibleTo (const QWidget *ancestor) const const |
bool | isHidden () const const |
bool | isMinimized () const const |
bool | isMaximized () const const |
bool | isFullScreen () const const |
Qt::WindowStates | windowState () const const |
void | setWindowState (Qt::WindowStates windowState) |
virtual QSize | sizeHint () const const |
virtual QSize | minimumSizeHint () const const |
QSizePolicy | sizePolicy () const const |
void | setSizePolicy (QSizePolicy) |
void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
virtual int | heightForWidth (int w) const const |
virtual bool | hasHeightForWidth () const const |
QRegion | visibleRegion () const const |
void | setContentsMargins (int left, int top, int right, int bottom) |
void | setContentsMargins (const QMargins &margins) |
void | getContentsMargins (int *left, int *top, int *right, int *bottom) const const |
QMargins | contentsMargins () const const |
QRect | contentsRect () const const |
QLayout * | layout () const const |
void | setLayout (QLayout *layout) |
void | updateGeometry () |
void | setParent (QWidget *parent) |
void | setParent (QWidget *parent, Qt::WindowFlags f) |
void | scroll (int dx, int dy) |
void | scroll (int dx, int dy, const QRect &r) |
QWidget * | focusWidget () const const |
QWidget * | nextInFocusChain () const const |
QWidget * | previousInFocusChain () const const |
bool | acceptDrops () const const |
void | setAcceptDrops (bool on) |
void | addAction (QAction *action) |
void | addActions (QList< QAction * > actions) |
void | insertActions (QAction *before, QList< QAction * > actions) |
void | insertAction (QAction *before, QAction *action) |
void | removeAction (QAction *action) |
QList< QAction * > | actions () const const |
QWidget * | parentWidget () const const |
void | setWindowFlags (Qt::WindowFlags type) |
Qt::WindowFlags | windowFlags () const const |
void | setWindowFlag (Qt::WindowType flag, bool on) |
void | overrideWindowFlags (Qt::WindowFlags flags) |
Qt::WindowType | windowType () const const |
QWidget * | childAt (int x, int y) const const |
QWidget * | childAt (const QPoint &p) const const |
void | setAttribute (Qt::WidgetAttribute attribute, bool on) |
bool | testAttribute (Qt::WidgetAttribute attribute) const const |
virtual QPaintEngine * | paintEngine () const const override |
void | ensurePolished () const const |
bool | isAncestorOf (const QWidget *child) const const |
bool | hasEditFocus () const const |
void | setEditFocus (bool enable) |
bool | autoFillBackground () const const |
void | setAutoFillBackground (bool enabled) |
QBackingStore * | backingStore () const const |
QWindow * | windowHandle () const const |
void | windowTitleChanged (const QString &title) |
void | windowIconChanged (const QIcon &icon) |
void | windowIconTextChanged (const QString &iconText) |
void | customContextMenuRequested (const QPoint &pos) |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery query) const const |
Qt::InputMethodHints | inputMethodHints () const const |
void | setInputMethodHints (Qt::InputMethodHints hints) |
QWIDGETSIZE_MAX QWIDGETSIZE_MAX | |
Public Member Functions inherited from QObject | |
virtual const QMetaObject * | metaObject () const const |
QObject (QObject *parent) | |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
QString | objectName () const const |
void | setObjectName (const QString &name) |
bool | isWidgetType () const const |
bool | isWindowType () const const |
bool | signalsBlocked () const const |
bool | blockSignals (bool block) |
QThread * | thread () const const |
void | moveToThread (QThread *targetThread) |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
void | killTimer (int id) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
const QObjectList & | children () const const |
void | setParent (QObject *parent) |
void | installEventFilter (QObject *filterObj) |
void | removeEventFilter (QObject *obj) |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectTree () |
void | dumpObjectInfo () |
void | dumpObjectTree () const const |
void | dumpObjectInfo () const const |
bool | setProperty (const char *name, const QVariant &value) |
QVariant | property (const char *name) const const |
QList< QByteArray > | dynamicPropertyNames () const const |
void | destroyed (QObject *obj) |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
bool | inherits (const char *className) const const |
void | deleteLater () |
Q_DISABLE_COPY (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
T | qobject_cast (QObject *object) |
T | qobject_cast (const QObject *object) |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
Q_CLASSINFO (Name, Value) | |
Q_INTERFACES (...) | |
Q_PROPERTY (...) | |
Q_ENUMS (...) | |
Q_FLAGS (...) | |
Q_ENUM (...) | |
Q_FLAG (...) | |
Q_ENUM_NS (...) | |
Q_FLAG_NS (...) | |
Q_OBJECT Q_OBJECT | |
Q_GADGET Q_GADGET | |
Q_NAMESPACE Q_NAMESPACE | |
Q_SIGNALS Q_SIGNALS | |
Q_SIGNAL Q_SIGNAL | |
Q_SLOTS Q_SLOTS | |
Q_SLOT Q_SLOT | |
Q_EMIT Q_EMIT | |
Q_INVOKABLE Q_INVOKABLE | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
Public Member Functions inherited from QPaintDevice | |
bool | paintingActive () const const |
int | width () const const |
int | height () const const |
int | widthMM () const const |
int | heightMM () const const |
int | logicalDpiX () const const |
int | logicalDpiY () const const |
int | physicalDpiX () const const |
int | physicalDpiY () const const |
int | devicePixelRatio () const const |
qreal | devicePixelRatioF () const const |
int | colorCount () const const |
int | depth () const const |
Additional Inherited Members | |
Static Public Member Functions inherited from QWidget | |
void | setTabOrder (QWidget *first, QWidget *second) |
QWidget * | mouseGrabber () |
QWidget * | keyboardGrabber () |
QWidget * | find (WId id) |
QWidget * | createWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags) |
Static Public Member Functions inherited from QObject | |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
Public Attributes inherited from QWidget | |
typedef | RenderFlags |
Public Attributes inherited from QObject | |
typedef | QObjectList |
Protected Member Functions inherited from QWidget | |
virtual bool | event (QEvent *event) override |
virtual void | mousePressEvent (QMouseEvent *event) |
virtual void | mouseReleaseEvent (QMouseEvent *event) |
virtual void | mouseDoubleClickEvent (QMouseEvent *event) |
virtual void | mouseMoveEvent (QMouseEvent *event) |
virtual void | wheelEvent (QWheelEvent *event) |
virtual void | keyPressEvent (QKeyEvent *event) |
virtual void | keyReleaseEvent (QKeyEvent *event) |
virtual void | focusInEvent (QFocusEvent *event) |
virtual void | focusOutEvent (QFocusEvent *event) |
virtual void | enterEvent (QEvent *event) |
virtual void | leaveEvent (QEvent *event) |
virtual void | paintEvent (QPaintEvent *event) |
virtual void | moveEvent (QMoveEvent *event) |
virtual void | resizeEvent (QResizeEvent *event) |
virtual void | closeEvent (QCloseEvent *event) |
virtual void | contextMenuEvent (QContextMenuEvent *event) |
virtual void | tabletEvent (QTabletEvent *event) |
virtual void | actionEvent (QActionEvent *event) |
virtual void | dragEnterEvent (QDragEnterEvent *event) |
virtual void | dragMoveEvent (QDragMoveEvent *event) |
virtual void | dragLeaveEvent (QDragLeaveEvent *event) |
virtual void | dropEvent (QDropEvent *event) |
virtual void | showEvent (QShowEvent *event) |
virtual void | hideEvent (QHideEvent *event) |
virtual bool | nativeEvent (const QByteArray &eventType, void *message, long *result) |
virtual void | changeEvent (QEvent *event) |
virtual int | metric (QPaintDevice::PaintDeviceMetric m) const const override |
virtual void | initPainter (QPainter *painter) const const override |
virtual void | inputMethodEvent (QInputMethodEvent *event) |
void | updateMicroFocus () |
void | create (WId window, bool initializeWindow, bool destroyOldWindow) |
void | destroy (bool destroyWindow, bool destroySubWindows) |
virtual bool | focusNextPrevChild (bool next) |
bool | focusNextChild () |
bool | focusPreviousChild () |
Protected Member Functions inherited from QObject | |
QObject * | sender () const const |
int | senderSignalIndex () const const |
int | receivers (const char *signal) const const |
bool | isSignalConnected (const QMetaMethod &signal) const const |
virtual void | timerEvent (QTimerEvent *event) |
virtual void | childEvent (QChildEvent *event) |
virtual void | customEvent (QEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
A simple button for update checks.
The UpdateButton is a ready-made "button" to check for updates. It is connected to an updater and thus will automatically start checking for updates. It will also display a progress and optionally allow canceling and installation of updates.
The button will represent the updaters state and automatically enable/disable itself to avoid start beeing called twice. In addition to that, the whole button widget will be disabled if the updater gets deleted while the button is still existant.
Definition at line 15 of file updatebutton.h.
|
strong |
Defines various flags to specify how the button should behave.
Enumerator | |
---|---|
ShowResult | Show a result (e.g. "new updates") after a check completed next to the button. |
ShowStatus | Show the check status as provided via Updater::progressChanged instead of a simple "checking for updates". |
AllowInstall | Allow the user to launch an installer via the button if updates are available. |
AllowCancel | Allow the user to cancel the update check. |
None | Value to enable none of these features. |
AllowAndShowAll | Enables all features at once. |
Definition at line 32 of file updatebutton.h.
|
readwrite |
The file of the animation to be shown.
Default: :/QtAutoUpdater/icons/updateRunning.gif
The default file will show a simple idle animation. If this does not fit the style of your ui, you can use this property to specify a different animation source.
Accessors | |
---|---|
READ | animationFile() |
WRITE | setAnimationFile() |
WRITE | setAnimationDevice() |
RESET | resetAnimationFile() |
NOTIFY | animationFileChanged() |
Definition at line 24 of file updatebutton.h.
|
readwrite |
The installation mode to be used to install updates.
Default: Updater::InstallModeFlag::Parallel
The install mode to be passed to Updater::runUpdater, if the ModeFlag::AllowInstall flag is set and the user launches an installation via the button.
Accessors | |
---|---|
READ | installMode() |
WRITE | setInstallMode() |
NOTIFY | installModeChanged() |
Definition at line 26 of file updatebutton.h.
|
readwrite |
The installation scope to be used to install updates.
Default: Updater::InstallScope::PreferInternal
The install scope to be passed to Updater::runUpdater, if the ModeFlag::AllowInstall flag is set and the user launches an installation via the button.
Accessors | |
---|---|
READ | installScope() |
WRITE | setInstallScope() |
NOTIFY | installScopeChanged() |
Definition at line 28 of file updatebutton.h.
|
readwrite |
Holds the mode of the button.
Default: UpdateButton::ModeFlag::AllowAndShowAll
The mode is used to control the buttons behaviour. See UpdateButton::ModeFlag for details about what each mode does. By default, all features are enabled.
Accessors | |
---|---|
READ | mode() |
WRITE | setMode() |
NOTIFY | modeChanged() |
Definition at line 22 of file updatebutton.h.
|
readwrite |
The updater the button will use to check for updates.
Default: nullptr
The button can only be used if the updater was set, either directly or via the constructor. The button attaches to the updater and reacts on changes in it's state to react accordingly.
Accessors | |
---|---|
READ | updater() |
WRITE | setUpdater() |
NOTIFY | updaterChanged() |
Definition at line 20 of file updatebutton.h.