QGIS API Documentation  2.99.0-Master (23ddace)
Signals | Public Member Functions | List of all members
QgsFocusWatcher Class Reference

A event filter for watching for focus events on a parent object. More...

#include <qgsfocuswatcher.h>

Inheritance diagram for QgsFocusWatcher:
Inheritance graph
[legend]

Signals

void focusChanged (bool focused)
 Emitted when parent object's focus changes. More...
 
void focusIn ()
 Emitted when parent object gains focus. More...
 
void focusOut ()
 Emitted when parent object loses focus. More...
 

Public Member Functions

 QgsFocusWatcher (QObject *parent)
 Constructor for QgsFocusWatcher. More...
 
virtual bool eventFilter (QObject *obj, QEvent *event) override
 

Detailed Description

A event filter for watching for focus events on a parent object.

Usually QObjects must subclass and override methods like focusOutEvent to handle focus events. Using this class as an event filter avoids the need to subclass objects and the focus events can be directly caught using the emitted signals.

Since
QGIS 2.16

Definition at line 32 of file qgsfocuswatcher.h.

Constructor & Destructor Documentation

◆ QgsFocusWatcher()

QgsFocusWatcher::QgsFocusWatcher ( QObject *  parent)
explicit

Constructor for QgsFocusWatcher.

Parameters
parentparent widget to catch focus events for. This class will automatically be installed as an event filter for parent.

Definition at line 19 of file qgsfocuswatcher.cpp.

Member Function Documentation

◆ eventFilter()

bool QgsFocusWatcher::eventFilter ( QObject *  obj,
QEvent *  event 
)
overridevirtual

Definition at line 26 of file qgsfocuswatcher.cpp.

◆ focusChanged

void QgsFocusWatcher::focusChanged ( bool  focused)
signal

Emitted when parent object's focus changes.

Parameters
focusedtrue if object gained focus, false if object lost focus

◆ focusIn

void QgsFocusWatcher::focusIn ( )
signal

Emitted when parent object gains focus.

◆ focusOut

void QgsFocusWatcher::focusOut ( )
signal

Emitted when parent object loses focus.


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