KAuth::ObjectDecorator Class Reference

#include <KAuth/ObjectDecorator>

Inheritance diagram for KAuth::ObjectDecorator:

Signals
void	authorized (const KAuth::Action &action)

Public Member Functions
	ObjectDecorator (QObject *parent)
	~ObjectDecorator () override
KAuth::Action	authAction () const
void	setAuthAction (const KAuth::Action &action)
void	setAuthAction (const QString &actionName)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () 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 ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, 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
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
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)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

A decorator to add auth features to a button or an action.

Author

Dario Freddi [email protected][email protected]de.o[email protected]rg

Definition at line 31 of file objectdecorator.h.

Constructor & Destructor Documentation

ObjectDecorator()

KAuth::ObjectDecorator::ObjectDecorator ( QObject *  parent )

explicit

Instantiate a new decorator attached to an object.

Parameters

parent

The parent object this decorator will be attached to

Definition at line 118 of file objectdecorator.cpp.

~ObjectDecorator()

KAuth::ObjectDecorator::~ObjectDecorator ( )

overridedefault

Destructs the decorator.

Member Function Documentation

authAction()

KAuth::Action KAuth::ObjectDecorator::authAction

(

)

const

Returns the action object associated with this decorator, or an invalid action if it does not have one.

Returns

the KAuth::Action associated with this decorator.

Definition at line 127 of file objectdecorator.cpp.

authorized

void KAuth::ObjectDecorator::authorized ( const KAuth::Action &  action )

signal

Signal emitted when the action is authorized.

If the decorator needs authorization, whenever the user triggers it, the authorization process automatically begins. If it succeeds, this signal is emitted. The KAuth::Action object is provided for convenience if you have multiple Action objects, but of course it's always the same set with setAuthAction().

WARNING: If your button or action needs authorization you should connect eventual slots processing stuff to this signal, and NOT clicked/triggered. Clicked/triggered will be emitted even if the user has not been authorized

Parameters

action

The object set with setAuthAction()

setAuthAction() [1/2]

void KAuth::ObjectDecorator::setAuthAction

(

const KAuth::Action &

action

)

Sets the action object associated with this decorator.

By setting a KAuth::Action, this decorator will become associated with it, and whenever the action or button it is attached to gets clicked, it will trigger the authorization and execution process for the action. Pass an invalid action to this function to disassociate the decorator.

Parameters

action

the KAuth::Action to associate with this decorator.

Definition at line 141 of file objectdecorator.cpp.

setAuthAction() [2/2]

void KAuth::ObjectDecorator::setAuthAction

(

const QString &

actionName

)

Sets the action object associated with this decorator.

Overloaded member to allow creating the action by name

Parameters

actionName

the name of the action to associate

Definition at line 132 of file objectdecorator.cpp.

---

The documentation for this class was generated from the following files:

• objectdecorator.h
• objectdecorator.cpp