Qt 4.8
Public Functions | List of all members
QInputContextPlugin Class Referenceabstract

The QInputContextPlugin class provides an abstract base for custom QInputContext plugins. More...

#include <qinputcontextplugin.h>

Inheritance diagram for QInputContextPlugin:
QObject QInputContextFactoryInterface QFactoryInterface QMultiInputContextPlugin

Public Functions

virtual QInputContextcreate (const QString &key)=0
 Creates and returns a QInputContext object for the input context key key. More...
 
virtual QString description (const QString &key)=0
 Returns an internationalized brief description of the QInputContext object specified by key. More...
 
virtual QString displayName (const QString &key)=0
 Returns a user friendly internationalized name of the QInputContext object specified by key. More...
 
virtual QStringList keys () const =0
 Returns the list of QInputContext keys this plugin provides. More...
 
virtual QStringList languages (const QString &key)=0
 Returns the languages supported by the QInputContext object specified by key. More...
 
 QInputContextPlugin (QObject *parent=0)
 Constructs a input context plugin with the given parent. More...
 
 ~QInputContextPlugin ()
 Destroys the input context plugin. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool event (QEvent *)
 This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) 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. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
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. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 
- Public Functions inherited from QFactoryInterface
virtual ~QFactoryInterface ()
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QInputContextPlugin class provides an abstract base for custom QInputContext plugins.

Note
This class or function is reentrant.

The input context plugin is a simple plugin interface that makes it easy to create custom input contexts that can be loaded dynamically into applications.

To create an input context plugin you subclass this base class, reimplement the pure virtual functions keys(), create(), languages(), displayName(), and description(), and export the class with the Q_EXPORT_PLUGIN2() macro.

Copyright (C) 2003-2004 immodule for Qt Project. All rights reserved.

This file is written to contribute to Nokia Corporation and/or its subsidiary(-ies) under their own license. You may use this file under your Qt license. Following description is copied from their original file headers. Contact immod.nosp@m.ule-.nosp@m.qt@fr.nosp@m.eede.nosp@m.sktop.nosp@m..org if any conditions of this licensing are not clear to you.

See also
QInputContext, {How to Create Qt Plugins}

Definition at line 85 of file qinputcontextplugin.h.

Constructors and Destructors

◆ QInputContextPlugin()

QInputContextPlugin::QInputContextPlugin ( QObject parent = 0)
explicit

Constructs a input context plugin with the given parent.

This is invoked automatically by the Q_EXPORT_PLUGIN2() macro.

Definition at line 174 of file qinputcontextplugin.cpp.

175  :QObject(parent)
176 {
177 }
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753

◆ ~QInputContextPlugin()

QInputContextPlugin::~QInputContextPlugin ( )

Destroys the input context plugin.

You never have to call this explicitly. Qt destroys a plugin automatically when it's no longer used.

Definition at line 185 of file qinputcontextplugin.cpp.

186 {
187 }

Functions

◆ create()

QInputContext * QInputContextPlugin::create ( const QString key)
pure virtual

Creates and returns a QInputContext object for the input context key key.

The input context key is usually the class name of the required input method.

See also
keys()

Implements QInputContextFactoryInterface.

Implemented in QMultiInputContextPlugin.

◆ description()

QString QInputContextPlugin::description ( const QString key)
pure virtual

Returns an internationalized brief description of the QInputContext object specified by key.

You can, for example, use this description in a user interface.

See also
keys(), displayName()

Implements QInputContextFactoryInterface.

Implemented in QMultiInputContextPlugin.

◆ displayName()

QString QInputContextPlugin::displayName ( const QString key)
pure virtual

Returns a user friendly internationalized name of the QInputContext object specified by key.

You can, for example, use this name in a menu.

See also
keys(), QInputContext::identifierName()

Implements QInputContextFactoryInterface.

Implemented in QMultiInputContextPlugin.

◆ keys()

QStringList QInputContextPlugin::keys ( ) const
pure virtual

Returns the list of QInputContext keys this plugin provides.

These keys are usually the class names of the custom input context that are implemented in the plugin. The names are used, for example, to identify and specify input methods for the input method switching mechanism. They have to be consistent with QInputContext::identifierName(), and may only contain ASCII characters.

See also
create(), displayName(), QInputContext::identifierName()

Implements QFactoryInterface.

Implemented in QMultiInputContextPlugin.

◆ languages()

QStringList QInputContextPlugin::languages ( const QString key)
pure virtual

Returns the languages supported by the QInputContext object specified by key.

The languages are expressed as language code (e.g. "zh_CN", "zh_TW", "zh_HK", "ja", "ko", ...). An input context that supports multiple languages can return all supported languages as QStringList. The name has to be consistent with QInputContext::language().

This information may be used to optimize user interface.

See also
keys(), QInputContext::language(), QLocale

Implements QInputContextFactoryInterface.

Implemented in QMultiInputContextPlugin.


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