Search for usage in LXR

#include <ActionButton>

Inheritance diagram for PolkitQt1::Gui::ActionButton:


void clicked (QAbstractButton *button, bool checked=false)
- Signals inherited from PolkitQt1::Gui::Action
void authorized ()
void dataChanged ()

Public Slots

bool activate ()
- Public Slots inherited from PolkitQt1::Gui::Action
bool activate ()
void revoke ()
void setChecked (bool checked)

Public Member Functions

 ActionButton (QAbstractButton *button, const QString &actionId=QString(), QObject *parent=nullptr)
QAbstractButtonbutton () const
void setButton (QAbstractButton *button)
- Public Member Functions inherited from PolkitQt1::Gui::Action
 Action (const QString &actionId=QString(), QObject *parent=nullptr)
QString actionId () const
QIcon icon (State state=None) const
bool is (const QString &actionId) const
bool isAllowed () const
bool isEnabled (State state=None) const
bool isVisible (State state=None) const
void setEnabled (bool enabled, States states=All)
void setIcon (const QIcon &icon, States states=All)
void setPolkitAction (const QString &actionId)
void setTargetPID (qint64 pid)
void setText (const QString &text, States states=All)
void setToolTip (const QString &toolTip, States states=All)
void setVisible (bool visible, States states=All)
void setWhatsThis (const QString &whatsThis, States states=All)
qint64 targetPID () const
QString text (State state=None) const
QString toolTip (State state=None) const
QString whatsThis (State state=None) const
- Public Member Functions inherited from QAction
 QAction (const QIcon &icon, const QString &text, QObject *parent)
 QAction (const QString &text, QObject *parent)
 QAction (QObject *parent)
QActionGroupactionGroup () const const
void activate (ActionEvent event)
QList< QGraphicsWidget * > associatedGraphicsWidgets () const const
QList< QObject * > associatedObjects () const const
QList< QWidget * > associatedWidgets () const const
bool autoRepeat () const const
void changed ()
void checkableChanged (bool checkable)
QVariant data () const const
void enabledChanged (bool enabled)
QFont font () const const
void hover ()
void hovered ()
QIcon icon () const const
QString iconText () const const
bool isCheckable () const const
bool isChecked () const const
bool isEnabled () const const
bool isIconVisibleInMenu () const const
bool isSeparator () const const
bool isShortcutVisibleInContextMenu () const const
bool isVisible () const const
QMenumenu () const const
MenuRole menuRole () const const
QWidgetparentWidget () const const
Priority priority () const const
void resetEnabled ()
void setActionGroup (QActionGroup *group)
void setAutoRepeat (bool)
void setCheckable (bool)
void setChecked (bool)
void setData (const QVariant &data)
void setDisabled (bool b)
void setEnabled (bool)
void setFont (const QFont &font)
void setIcon (const QIcon &icon)
void setIconText (const QString &text)
void setIconVisibleInMenu (bool visible)
void setMenu (QMenu *menu)
void setMenuRole (MenuRole menuRole)
void setPriority (Priority priority)
void setSeparator (bool b)
void setShortcut (const QKeySequence &shortcut)
void setShortcutContext (Qt::ShortcutContext context)
void setShortcuts (const QList< QKeySequence > &shortcuts)
void setShortcuts (QKeySequence::StandardKey key)
void setShortcutVisibleInContextMenu (bool show)
void setStatusTip (const QString &statusTip)
void setText (const QString &text)
void setToolTip (const QString &tip)
void setVisible (bool)
void setWhatsThis (const QString &what)
QKeySequence shortcut () const const
Qt::ShortcutContext shortcutContext () const const
QList< QKeySequenceshortcuts () const const
bool showStatusText (QObject *object)
QString statusTip () const const
QString text () const const
void toggle ()
void toggled (bool checked)
QString toolTip () const const
void trigger ()
void triggered (bool checked)
void visibleChanged ()
QString whatsThis () const const
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
QBindable< QStringbindableObjectName ()
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo () const const
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isQuickItemType () const const
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setObjectName (QAnyStringView name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool setProperty (const char *name, QVariant &&value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThreadthread () const const

Protected Member Functions

 ActionButton (ActionButtonPrivate &dd, const QString &actionId, QObject *parent=nullptr)
- Protected Member Functions inherited from QAction
virtual bool event (QEvent *e) override
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)

Protected Attributes

ActionButtonPrivate *const d_ptr

Additional Inherited Members

- Public Types inherited from PolkitQt1::Gui::Action
enum  State {
  None = 0 , SelfBlocked = 1 , Yes = 2 , No = 4 ,
  Auth = 8 , All = 512
typedef QFlags< StateStates
- Public Types inherited from QAction
enum  ActionEvent
enum  MenuRole
enum  Priority
- Properties inherited from QAction
- Properties inherited from QObject
- Static Public Member Functions inherited from QObject
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 *context, Functor functor, 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)
bool disconnect (const QMetaObject::Connection &connection)
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 QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
- Public Attributes inherited from QAction
- Public Attributes inherited from QObject
typedef QObjectList

Detailed Description

Class used to hold and update a QAbstractButton.

Daniel Nicoletti dantt.nosp@m.i85-.nosp@m.pk@ya.nosp@m.hoo..nosp@m.com.b.nosp@m.r
Dario Freddi drf@k.nosp@m.de.o.nosp@m.rg

This class allows you to associate QAbstractButtons (i.e. QPushButton) to a PolicyKit Action. It will update the button properties according to the PolicyKit Action automatically.

You should connect the activated() signal to receive a notification when the user clicked the button and gets permission to perform the given action. If you set 'noEnabled' to true it will be emitted when PolKitResult is NO.

Definition at line 39 of file polkitqt1-gui-actionbutton.h.

Constructor & Destructor Documentation

◆ ActionButton() [1/2]

PolkitQt1::Gui::ActionButton::ActionButton ( QAbstractButton * button,
const QString & actionId = QString(),
QObject * parent = nullptr )

Constructs a new ActionButton.

You need to pass this constructor an existing QAbstractButton, whose properties will be modified according to the underlying Action object. As ActionButton inherits from Action, you can define your button's behavior right through this wrapper.

See also
buttonthe QAbstractButton to associate to this ActionButton
actionIdthe action Id to create the underlying Action
parentthe parent object

Definition at line 19 of file polkitqt1-gui-actionbutton.cpp.

◆ ~ActionButton()

PolkitQt1::Gui::ActionButton::~ActionButton ( )

Definition at line 38 of file polkitqt1-gui-actionbutton.cpp.

◆ ActionButton() [2/2]

PolkitQt1::Gui::ActionButton::ActionButton ( ActionButtonPrivate & dd,
const QString & actionId,
QObject * parent = nullptr )

Definition at line 29 of file polkitqt1-gui-actionbutton.cpp.

Member Function Documentation

◆ activate

bool PolkitQt1::Gui::ActionButton::activate ( )

Connect clicked() signals to this slot.

This should be manually done, as in some cases we might want to manually call this. Calling this will emit authorized().

This slot is reentrant which is likely to only be a problem if you are creating an interface to setup PolicyKit policies.
If you have a checkbox, connect to its' clicked() signal to avoid an infinite loop as this function internally calls setChecked(). You can always use the clicked(bool) signal in this class to connect to here.
if you use this class take care to not call Action::activate otherwise your checkable buttons won't be properly updated.

Definition at line 66 of file polkitqt1-gui-actionbutton.cpp.

◆ button()

QAbstractButton * PolkitQt1::Gui::ActionButton::button ( ) const

Returns the current button.

the button currently associated with the underlying action

Definition at line 135 of file polkitqt1-gui-actionbutton.cpp.

◆ clicked

void PolkitQt1::Gui::ActionButton::clicked ( QAbstractButton * button,
bool checked = false )

Emitted when the abstract button clicked(bool) signal is emitted.

This allows you to use qobject_cast<ActionButton *>(sender()) in a slot connected to this signal and call activate() on it.

you will normally want to connect this signal to the activate slot.
buttonthe button that has been clicked
checkedthe checked state, if applicable. Otherwise false

◆ setButton()

void PolkitQt1::Gui::ActionButton::setButton ( QAbstractButton * button)

Sets the button associated to the underlying action.

If you are calling this function, you're probably changing the button the action is referring to. If this is the case, please note that Polkit-Qt does not handle the previous button's memory, so you should take care of deleting it yourself (if needed). You can retrieve it by using button()
See also
buttonthe new button associated with the underlying action

Definition at line 87 of file polkitqt1-gui-actionbutton.cpp.

Member Data Documentation

◆ d_ptr

ActionButtonPrivate* const PolkitQt1::Gui::ActionButton::d_ptr

Definition at line 120 of file polkitqt1-gui-actionbutton.h.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:54:16 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.