MnemonicAttached

Search for usage in LXR

#include <mnemonicattached.h>

Inheritance diagram for MnemonicAttached:

Public Types

enum  ControlType {
  ActionElement , DialogButton , MenuItem , FormLabel ,
  SecondaryControl
}
 

Properties

bool active
 
MnemonicAttached::ControlType controlType
 
bool enabled
 
QString label
 
QString mnemonicLabel
 
QString richTextLabel
 
QKeySequence sequence
 
- Properties inherited from QObject
 objectName
 

Signals

void activeChanged ()
 
void controlTypeChanged ()
 
void enabledChanged ()
 
void labelChanged ()
 
void mnemonicLabelChanged ()
 
void richTextLabelChanged ()
 
void sequenceChanged ()
 

Public Member Functions

 MnemonicAttached (QObject *parent=nullptr)
 
bool active () const
 
ControlType controlType () const
 
bool enabled () const
 
QString label () const
 
QString mnemonicLabel () const
 
QString richTextLabel () const
 
QKeySequence sequence ()
 
void setActive (bool active)
 
void setControlType (MnemonicAttached::ControlType controlType)
 
void setEnabled (bool enabled)
 
void setLabel (const QString &text)
 
- 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 event (QEvent *e)
 
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_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 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
 
qobject_cast (const QObject *object)
 
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 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
 

Static Public Member Functions

static MnemonicAttachedqmlAttachedProperties (QObject *object)
 
- 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)
 

Protected Member Functions

void updateSequence ()
 
- 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)
 

Additional Inherited Members

- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

This Attached property is used to calculate automated keyboard sequences to trigger actions based upon their text: if an "&" mnemonic is used (ie "&Ok"), the system will attempt to assign the desired letter giving it priority, otherwise a letter among the ones in the label will be used if possible and not conflicting.

Different kinds of controls will have different priorities in assigning the shortcut: for instance the "Ok/Cancel" buttons in a dialog will have priority over fields of a FormLayout.

See also
ControlType

Usually the developer shouldn't use this directly as base components already use this, but only when implementing a custom graphical Control.

Since
2.3

Definition at line 30 of file mnemonicattached.h.

Member Enumeration Documentation

◆ ControlType

Enumerator
ActionElement 

pushbuttons, checkboxes etc

DialogButton 

buttons for dialogs

MenuItem 

Menu items.

FormLabel 

Buddy label in a FormLayout.

SecondaryControl 

Other controls that are considered not much important and low priority for shortcuts.

Definition at line 80 of file mnemonicattached.h.

Property Documentation

◆ active

bool MnemonicAttached::active
readwrite

True when the user is pressing alt and the accelerators should be shown.

Since
5.72
2.15

Definition at line 77 of file mnemonicattached.h.

◆ controlType

MnemonicAttached::ControlType MnemonicAttached::controlType
readwrite

The type of control this mnemonic is attached: different types of controls have different importance and priority for shortcut assignment.

See also
ControlType

Definition at line 64 of file mnemonicattached.h.

◆ enabled

bool MnemonicAttached::enabled
readwrite

Only if true this mnemonic will be considered for the global assignment default: true.

Definition at line 58 of file mnemonicattached.h.

◆ label

QString MnemonicAttached::label
readwrite

The label of the control we want to compute a mnemonic for, instance "Label:" or "&Ok".

Definition at line 40 of file mnemonicattached.h.

◆ mnemonicLabel

QString MnemonicAttached::mnemonicLabel
read

The label with an "&" mnemonic in the place which will have the shortcut assigned, regardless of whether the & was assigned by the user or automatically generated.

Definition at line 52 of file mnemonicattached.h.

◆ richTextLabel

QString MnemonicAttached::richTextLabel
read

The user-visible final label, which will have the shortcut letter underlined, such as "&lt;u&gt;O&lt;/u&gt;k".

Definition at line 46 of file mnemonicattached.h.

◆ sequence

QKeySequence MnemonicAttached::sequence
read

The final key sequence assigned, if any: it will be Alt+alphanumeric char.

Definition at line 69 of file mnemonicattached.h.

Constructor & Destructor Documentation

◆ MnemonicAttached()

MnemonicAttached::MnemonicAttached ( QObject * parent = nullptr)
explicit

Definition at line 159 of file mnemonicattached.cpp.

◆ ~MnemonicAttached()

MnemonicAttached::~MnemonicAttached ( )
override

Definition at line 166 of file mnemonicattached.cpp.

Member Function Documentation

◆ active()

bool MnemonicAttached::active ( ) const

Definition at line 455 of file mnemonicattached.cpp.

◆ controlType()

MnemonicAttached::ControlType MnemonicAttached::controlType ( ) const

Definition at line 445 of file mnemonicattached.cpp.

◆ enabled()

bool MnemonicAttached::enabled ( ) const

Definition at line 406 of file mnemonicattached.cpp.

◆ label()

QString MnemonicAttached::label ( ) const

Definition at line 390 of file mnemonicattached.cpp.

◆ mnemonicLabel()

QString MnemonicAttached::mnemonicLabel ( ) const

Definition at line 385 of file mnemonicattached.cpp.

◆ qmlAttachedProperties()

MnemonicAttached * MnemonicAttached::qmlAttachedProperties ( QObject * object)
static

Definition at line 460 of file mnemonicattached.cpp.

◆ richTextLabel()

QString MnemonicAttached::richTextLabel ( ) const

Definition at line 376 of file mnemonicattached.cpp.

◆ setActive()

void MnemonicAttached::setActive ( bool active)

Definition at line 465 of file mnemonicattached.cpp.

◆ setControlType()

void MnemonicAttached::setControlType ( MnemonicAttached::ControlType controlType)

Definition at line 411 of file mnemonicattached.cpp.

◆ setEnabled()

void MnemonicAttached::setEnabled ( bool enabled)

Definition at line 395 of file mnemonicattached.cpp.

◆ setLabel()

void MnemonicAttached::setLabel ( const QString & text)

Definition at line 365 of file mnemonicattached.cpp.

◆ updateSequence()

void MnemonicAttached::updateSequence ( )
protected

Definition at line 289 of file mnemonicattached.cpp.


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 Jul 19 2024 11:52:23 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.