Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
QIOSMenu Class Reference

#include <qiosmenu.h>

+ Inheritance diagram for QIOSMenu:
+ Collaboration diagram for QIOSMenu:

Public Member Functions

 QIOSMenu ()
 
 ~QIOSMenu ()
 
void insertMenuItem (QPlatformMenuItem *menuItem, QPlatformMenuItem *before) override
 
void removeMenuItem (QPlatformMenuItem *menuItem) override
 
void syncMenuItem (QPlatformMenuItem *) override
 
void syncSeparatorsCollapsible (bool) override
 
void setText (const QString &) override
 
void setIcon (const QIcon &) override
 
void setEnabled (bool enabled) override
 
void setVisible (bool visible) override
 
void setMenuType (MenuType type) override
 
void showPopup (const QWindow *parentWindow, const QRect &targetRect, const QPlatformMenuItem *item) override
 
void dismiss () override
 
QPlatformMenuItemmenuItemAt (int position) const override
 
QPlatformMenuItemmenuItemForTag (quintptr tag) const override
 
void handleItemSelected (QIOSMenuItem *menuItem)
 
- Public Member Functions inherited from QPlatformMenu
 QPlatformMenu ()
 
virtual void insertMenuItem (QPlatformMenuItem *menuItem, QPlatformMenuItem *before)=0
 
virtual void removeMenuItem (QPlatformMenuItem *menuItem)=0
 
virtual void syncMenuItem (QPlatformMenuItem *menuItem)=0
 
virtual void syncSeparatorsCollapsible (bool enable)=0
 
virtual void setTag (quintptr tag)
 
virtual quintptr tag () const
 
virtual void setText (const QString &text)=0
 
virtual void setIcon (const QIcon &icon)=0
 
virtual void setEnabled (bool enabled)=0
 
virtual bool isEnabled () const
 
virtual void setVisible (bool visible)=0
 
virtual void setMinimumWidth (int width)
 
virtual void setFont (const QFont &font)
 
virtual void setMenuType (MenuType type)
 
virtual void showPopup (const QWindow *parentWindow, const QRect &targetRect, const QPlatformMenuItem *item)
 
virtual void dismiss ()
 
virtual QPlatformMenuItemmenuItemAt (int position) const =0
 
virtual QPlatformMenuItemmenuItemForTag (quintptr tag) const =0
 
virtual QPlatformMenuItemcreateMenuItem () const
 
virtual QPlatformMenucreateSubMenu () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
template<typename T >
findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Static Public Member Functions

static QIOSMenucurrentMenu ()
 
static id menuActionTarget ()
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 

Protected Member Functions

bool eventFilter (QObject *obj, QEvent *event) override
 Filters events if this object has been installed as an event filter for the watched object.
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Additional Inherited Members

- Public Types inherited from QPlatformMenu
enum  MenuType { DefaultMenu = 0 , EditMenu }
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QPlatformMenu
void aboutToShow ()
 
void aboutToHide ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 49 of file qiosmenu.h.

Constructor & Destructor Documentation

◆ QIOSMenu()

QIOSMenu::QIOSMenu ( )

Definition at line 273 of file qiosmenu.mm.

◆ ~QIOSMenu()

QIOSMenu::~QIOSMenu ( )

Definition at line 287 of file qiosmenu.mm.

References dismiss().

+ Here is the call graph for this function:

Member Function Documentation

◆ currentMenu()

static QIOSMenu * QIOSMenu::currentMenu ( )
inlinestatic

Definition at line 74 of file qiosmenu.h.

◆ dismiss()

void QIOSMenu::dismiss ( )
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 390 of file qiosmenu.mm.

References QPlatformMenu::aboutToHide(), disconnect(), dismiss(), QPlatformMenu::EditMenu, emit, QGuiApplication::focusObjectChanged(), and qGuiApp.

Referenced by ~QIOSMenu(), dismiss(), handleItemSelected(), and showPopup().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ eventFilter()

bool QIOSMenu::eventFilter ( QObject watched,
QEvent event 
)
overrideprotectedvirtual

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
protected:
bool eventFilter(QObject *obj, QEvent *ev) override;
private:
};
{
setCentralWidget(textEdit);
}
{
if (obj == textEdit) {
if (event->type() == QEvent::KeyPress) {
QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
qDebug() << "Ate key press" << keyEvent->key();
return true;
} else {
return false;
}
} else {
// pass the event on to the parent class
}
}
bool eventFilter(QObject *obj, QEvent *ev) override
Filters events if this object has been installed as an event filter for the watched object.
\inmodule QtCore
Definition qcoreevent.h:45
@ KeyPress
Definition qcoreevent.h:64
The QKeyEvent class describes a key event.
Definition qevent.h:423
int key() const
Returns the code of the key that was pressed or released.
Definition qevent.h:433
The QMainWindow class provides a main application window.
Definition qmainwindow.h:25
\inmodule QtCore
Definition qobject.h:90
void installEventFilter(QObject *filterObj)
Installs an event filter filterObj on this object.
Definition qobject.cpp:2269
virtual bool eventFilter(QObject *watched, QEvent *event)
Filters events if this object has been installed as an event filter for the watched object.
Definition qobject.cpp:1518
The QTextEdit class provides a widget that is used to edit and display both plain and rich text.
Definition qtextedit.h:27
#define qDebug
[1]
Definition qlogging.h:160
struct _cl_event * event
GLhandleARB obj
[2]
QGraphicsWidget * textEdit

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.

Warning
If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.
See also
installEventFilter()

Reimplemented from QObject.

Definition at line 455 of file qiosmenu.mm.

References QObject::eventFilter(), QVariant::fromValue(), Qt::ImEnabled, Qt::ImPlatformData, QEvent::InputMethodQuery, QMap< Key, T >::insert(), kImePlatformDataHideShortcutsBar, kImePlatformDataInputAccessoryView, kImePlatformDataInputView, QInputMethodQueryEvent::queries(), QInputMethodQueryEvent::setValue(), QVariant::toMap(), QUIPickerView::toolbar, and QInputMethodQueryEvent::value().

+ Here is the call graph for this function:

◆ handleItemSelected()

void QIOSMenu::handleItemSelected ( QIOSMenuItem menuItem)

Definition at line 346 of file qiosmenu.mm.

References QPlatformMenuItem::activated(), dismiss(), emit, QIOSMenuItem::m_menu, and menu.

+ Here is the call graph for this function:

◆ insertMenuItem()

void QIOSMenu::insertMenuItem ( QPlatformMenuItem menuItem,
QPlatformMenuItem before 
)
overridevirtual

Implements QPlatformMenu.

Definition at line 292 of file qiosmenu.mm.

References QList< T >::append(), QListSpecialMethodsBase< T >::indexOf(), QList< T >::insert(), and syncMenuItem().

+ Here is the call graph for this function:

◆ menuActionTarget()

static id QIOSMenu::menuActionTarget ( )
inlinestatic

Definition at line 75 of file qiosmenu.h.

◆ menuItemAt()

QPlatformMenuItem * QIOSMenu::menuItemAt ( int  position) const
overridevirtual

Implements QPlatformMenu.

Definition at line 531 of file qiosmenu.mm.

References QList< T >::at(), position(), and QList< T >::size().

+ Here is the call graph for this function:

◆ menuItemForTag()

QPlatformMenuItem * QIOSMenu::menuItemForTag ( quintptr  tag) const
overridevirtual

Implements QPlatformMenu.

Definition at line 538 of file qiosmenu.mm.

References QList< T >::at(), i, item, QList< T >::size(), and QPlatformMenu::tag().

+ Here is the call graph for this function:

◆ removeMenuItem()

void QIOSMenu::removeMenuItem ( QPlatformMenuItem menuItem)
overridevirtual

Implements QPlatformMenu.

Definition at line 304 of file qiosmenu.mm.

References QList< T >::removeOne(), and syncMenuItem().

+ Here is the call graph for this function:

◆ setEnabled()

void QIOSMenu::setEnabled ( bool  enabled)
overridevirtual

Implements QPlatformMenu.

Definition at line 331 of file qiosmenu.mm.

References enabled.

◆ setIcon()

void QIOSMenu::setIcon ( const QIcon )
inlineoverridevirtual

Implements QPlatformMenu.

Definition at line 61 of file qiosmenu.h.

◆ setMenuType()

void QIOSMenu::setMenuType ( QPlatformMenu::MenuType  type)
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 341 of file qiosmenu.mm.

◆ setText()

void QIOSMenu::setText ( const QString text)
overridevirtual

Implements QPlatformMenu.

Definition at line 326 of file qiosmenu.mm.

References text.

◆ setVisible()

void QIOSMenu::setVisible ( bool  visible)
overridevirtual

Implements QPlatformMenu.

Definition at line 336 of file qiosmenu.mm.

◆ showPopup()

void QIOSMenu::showPopup ( const QWindow parentWindow,
const QRect targetRect,
const QPlatformMenuItem item 
)
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 357 of file qiosmenu.mm.

References QPlatformMenu::aboutToShow(), QObject::connect(), dismiss(), QPlatformMenu::EditMenu, emit, QGuiApplication::focusObjectChanged(), item, and qGuiApp.

+ Here is the call graph for this function:

◆ syncMenuItem()

void QIOSMenu::syncMenuItem ( QPlatformMenuItem )
overridevirtual

Implements QPlatformMenu.

Definition at line 311 of file qiosmenu.mm.

References QPlatformMenu::EditMenu.

Referenced by insertMenuItem(), and removeMenuItem().

+ Here is the caller graph for this function:

◆ syncSeparatorsCollapsible()

void QIOSMenu::syncSeparatorsCollapsible ( bool  )
inlineoverridevirtual

Implements QPlatformMenu.

Definition at line 58 of file qiosmenu.h.


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