Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QHelpSearchQueryWidgetPrivate Class Reference
+ Inheritance diagram for QHelpSearchQueryWidgetPrivate:
+ Collaboration diagram for QHelpSearchQueryWidgetPrivate:

Classes

class  CompleterModel
 
struct  QueryHistory
 

Public Member Functions

 QHelpSearchQueryWidgetPrivate ()
 
void retranslate ()
 
void saveQuery (const QString &query)
 
void nextOrPrevQuery (int maxOrMinIndex, int addend, QToolButton *thisButton, QToolButton *otherButton)
 
void enableOrDisableToolButtons ()
 
bool eventFilter (QObject *ob, QEvent *event) override
 Filters events if this object has been installed as an event filter for the watched object.
 
void searchRequested ()
 
void nextQuery ()
 
void prevQuery ()
 
 QHelpSearchQueryWidgetPrivate ()
 
void retranslate ()
 
void saveQuery (const QString &query)
 
void nextOrPrevQuery (int maxOrMinIndex, int addend, QToolButton *thisButton, QToolButton *otherButton)
 
void enableOrDisableToolButtons ()
 
bool eventFilter (QObject *ob, QEvent *event) override
 Filters events if this object has been installed as an event filter for the watched object.
 
void searchRequested ()
 
void nextQuery ()
 
void prevQuery ()
 
- 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.
 
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.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
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::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, 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 (QAnyStringView 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 >
findChild (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.
 
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.
 

Public Attributes

QLabelm_searchLabel = nullptr
 
QPushButtonm_searchButton = nullptr
 
QLineEditm_lineEdit = nullptr
 
QToolButtonm_nextQueryButton = nullptr
 
QToolButtonm_prevQueryButton = nullptr
 
QueryHistory m_queries
 
QCompleter m_searchCompleter
 
bool m_compactMode = false
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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.
 
- 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 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)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 18 of file qhelpsearchquerywidget.cpp.

Constructor & Destructor Documentation

◆ QHelpSearchQueryWidgetPrivate() [1/2]

QHelpSearchQueryWidgetPrivate::QHelpSearchQueryWidgetPrivate ( )
inline

Definition at line 58 of file qhelpsearchquerywidget.cpp.

◆ QHelpSearchQueryWidgetPrivate() [2/2]

QHelpSearchQueryWidgetPrivate::QHelpSearchQueryWidgetPrivate ( )
inline

Definition at line 58 of file qhelpsearchquerywidget.cpp.

Member Function Documentation

◆ enableOrDisableToolButtons() [1/2]

void QHelpSearchQueryWidgetPrivate::enableOrDisableToolButtons ( )
inline

Definition at line 97 of file qhelpsearchquerywidget.cpp.

◆ enableOrDisableToolButtons() [2/2]

void QHelpSearchQueryWidgetPrivate::enableOrDisableToolButtons ( )
inline

Definition at line 97 of file qhelpsearchquerywidget.cpp.

◆ eventFilter() [1/2]

bool QHelpSearchQueryWidgetPrivate::eventFilter ( QObject * watched,
QEvent * event )
inlineoverridevirtual

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:
QTextEdit *textEdit;
};
{
textEdit = new QTextEdit;
setCentralWidget(textEdit);
textEdit->installEventFilter(this);
}
{
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
}
}

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 103 of file qhelpsearchquerywidget.cpp.

References nextQuery(), and prevQuery().

+ Here is the call graph for this function:

◆ eventFilter() [2/2]

bool QHelpSearchQueryWidgetPrivate::eventFilter ( QObject * watched,
QEvent * event )
inlineoverridevirtual

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:
QTextEdit *textEdit;
};
{
textEdit = new QTextEdit;
setCentralWidget(textEdit);
textEdit->installEventFilter(this);
}
{
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
}
}

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 103 of file qhelpsearchquerywidget.cpp.

◆ nextOrPrevQuery() [1/2]

void QHelpSearchQueryWidgetPrivate::nextOrPrevQuery ( int maxOrMinIndex,
int addend,
QToolButton * thisButton,
QToolButton * otherButton )
inline

Definition at line 80 of file qhelpsearchquerywidget.cpp.

◆ nextOrPrevQuery() [2/2]

void QHelpSearchQueryWidgetPrivate::nextOrPrevQuery ( int maxOrMinIndex,
int addend,
QToolButton * thisButton,
QToolButton * otherButton )
inline

Definition at line 80 of file qhelpsearchquerywidget.cpp.

◆ nextQuery() [1/2]

void QHelpSearchQueryWidgetPrivate::nextQuery ( )
inline

Definition at line 130 of file qhelpsearchquerywidget.cpp.

Referenced by eventFilter().

+ Here is the caller graph for this function:

◆ nextQuery() [2/2]

void QHelpSearchQueryWidgetPrivate::nextQuery ( )
inline

Definition at line 130 of file qhelpsearchquerywidget.cpp.

◆ prevQuery() [1/2]

void QHelpSearchQueryWidgetPrivate::prevQuery ( )
inline

Definition at line 135 of file qhelpsearchquerywidget.cpp.

Referenced by eventFilter().

+ Here is the caller graph for this function:

◆ prevQuery() [2/2]

void QHelpSearchQueryWidgetPrivate::prevQuery ( )
inline

Definition at line 135 of file qhelpsearchquerywidget.cpp.

◆ retranslate() [1/2]

void QHelpSearchQueryWidgetPrivate::retranslate ( )
inline

Definition at line 60 of file qhelpsearchquerywidget.cpp.

◆ retranslate() [2/2]

void QHelpSearchQueryWidgetPrivate::retranslate ( )
inline

Definition at line 60 of file qhelpsearchquerywidget.cpp.

◆ saveQuery() [1/2]

void QHelpSearchQueryWidgetPrivate::saveQuery ( const QString & query)
inline

Definition at line 70 of file qhelpsearchquerywidget.cpp.

◆ saveQuery() [2/2]

void QHelpSearchQueryWidgetPrivate::saveQuery ( const QString & query)
inline

Definition at line 70 of file qhelpsearchquerywidget.cpp.

◆ searchRequested() [1/2]

void QHelpSearchQueryWidgetPrivate::searchRequested ( )
inline

Definition at line 121 of file qhelpsearchquerywidget.cpp.

◆ searchRequested() [2/2]

void QHelpSearchQueryWidgetPrivate::searchRequested ( )
inline

Definition at line 121 of file qhelpsearchquerywidget.cpp.

Member Data Documentation

◆ m_compactMode

bool QHelpSearchQueryWidgetPrivate::m_compactMode = false

Definition at line 144 of file qhelpsearchquerywidget.cpp.

◆ m_lineEdit

QLineEdit * QHelpSearchQueryWidgetPrivate::m_lineEdit = nullptr

Definition at line 139 of file qhelpsearchquerywidget.cpp.

◆ m_nextQueryButton

QToolButton * QHelpSearchQueryWidgetPrivate::m_nextQueryButton = nullptr

Definition at line 140 of file qhelpsearchquerywidget.cpp.

◆ m_prevQueryButton

QToolButton * QHelpSearchQueryWidgetPrivate::m_prevQueryButton = nullptr

Definition at line 141 of file qhelpsearchquerywidget.cpp.

◆ m_queries

QueryHistory QHelpSearchQueryWidgetPrivate::m_queries

Definition at line 142 of file qhelpsearchquerywidget.cpp.

◆ m_searchButton

QPushButton * QHelpSearchQueryWidgetPrivate::m_searchButton = nullptr

Definition at line 138 of file qhelpsearchquerywidget.cpp.

◆ m_searchCompleter

QCompleter QHelpSearchQueryWidgetPrivate::m_searchCompleter

Definition at line 143 of file qhelpsearchquerywidget.cpp.

◆ m_searchLabel

QLabel * QHelpSearchQueryWidgetPrivate::m_searchLabel = nullptr

Definition at line 137 of file qhelpsearchquerywidget.cpp.


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