IBus::Bus Class Reference

Inheritance diagram for IBus::Bus:
IBus::Object

List of all members.

Signals

void disconnected (void)
 Emited when bus is disconnected from ibus daemon.
void connected (void)
 Emited when bus is connected to ibus daemon.

Public Member Functions

 Bus (void)
 Constructor of Bus object.
 ~Bus (void)
 Destructor of Bus object.
bool isConnected (void)
 Gets whether the bus is connected to ibus daemon.
const QDBusConnection & getConnection (void)
 Gets the QDBusConnection object.
QString hello (void)
 Says hello to ibus daemon, and gets a unique name from the daemon.
void addMatch (const QString &rule)
 Adds a match rule to match message going through the bus.
void removeMatch (const QString &rule)
 Removes a match rule to match message going through the bus.
QString getId (void)
 Asks ibus daemon to return its globally unique ID.
QString getNameOwner (const QString &name)
 Asks ibus daemon to return the owner of a bus name.
QStringList listNames (void)
 Asks ibus daemon to return all client names.
bool nameHasOwner (const QString &name)
 Gets whether name has an owner.
uint requestName (const QString &name, uint flag)
 Asks ibus daemon to assign the given name to this connection.
uint releaseName (const QString &name)
 Asks ibus daemon to release the given name of this connection.
QString createInputContext (const QString &name)
 Asks ibus daemon to create an input context.
bool registerComponent (const ComponentPointer &component)
 Registers a components with ibus daemon.
bool registerObject (const QString &path, QObject *obj)
 Registers an object with the connection.
QList< EngineDescPointerlistEngines (void)
 Asks ibus daemon to return a list of engines.
QList< EngineDescPointerlistActiveEngines (void)
 Asks ibus daemon to return a list of active engines.
bool exit (bool restart=false)
 Asks ibus daemon to exit.
SerializablePointer ping (const SerializablePointer &data)
 Pings ibus daemon with a serializable object.

Constructor & Destructor Documentation

IBus::Bus::Bus ( void   ) 

Constructor of Bus object.

Returns:
IBus::Bus::~Bus ( void   ) 

Destructor of Bus object.

Returns:

Member Function Documentation

void IBus::Bus::addMatch ( const QString &  rule  ) 

Adds a match rule to match message going through the bus.

Parameters:
[in] rule Match rule
Returns:
QString IBus::Bus::createInputContext ( const QString &  name  ) 

Asks ibus daemon to create an input context.

Parameters:
[in] name Client name
Returns:
Object path of the input context
bool IBus::Bus::exit ( bool  restart = false  ) 

Asks ibus daemon to exit.

Parameters:
[in] restart Whether restart ibus daemon after exiting
Returns:
true if suceeded, false otherwise.
const QDBusConnection & IBus::Bus::getConnection ( void   ) 

Gets the QDBusConnection object.

Returns:
QDBusConnection object in Bus.
QString IBus::Bus::getId ( void   ) 

Asks ibus daemon to return its globally unique ID.

Returns:
the bus ID or Null
QString IBus::Bus::getNameOwner ( const QString &  name  ) 

Asks ibus daemon to return the owner of a bus name.

Returns:
name owner or Null
QString IBus::Bus::hello ( void   ) 

Says hello to ibus daemon, and gets a unique name from the daemon.

Returns:
unique name from ibus daemon
bool IBus::Bus::isConnected ( void   ) 

Gets whether the bus is connected to ibus daemon.

Returns:
true if is connected to ibus daemon, otherwise false.
QList< EngineDescPointer > IBus::Bus::listActiveEngines ( void   ) 

Asks ibus daemon to return a list of active engines.

Returns:
A List of active engines
QList< EngineDescPointer > IBus::Bus::listEngines ( void   ) 

Asks ibus daemon to return a list of engines.

Returns:
A List of engines
QStringList IBus::Bus::listNames ( void   ) 

Asks ibus daemon to return all client names.

Returns:
List of names
bool IBus::Bus::nameHasOwner ( const QString &  name  ) 

Gets whether name has an owner.

Parameters:
[in] name Bus name
Returns:
true if the name has owner, false otherwise.
SerializablePointer IBus::Bus::ping ( const SerializablePointer data  ) 

Pings ibus daemon with a serializable object.

Parameters:
[in] data The data will be sent to ibus daemon.
Returns:
The data from ibus daemon.
bool IBus::Bus::registerComponent ( const ComponentPointer component  ) 

Registers a components with ibus daemon.

Parameters:
[in] component A Component
Returns:
true if suceeded, false otherwise.
bool IBus::Bus::registerObject ( const QString &  path,
QObject *  obj 
)

Registers an object with the connection.

Parameters:
[in] path The object path.
[in] obj The object pointer.
Returns:
true if suceeded, false otherwise.
uint IBus::Bus::releaseName ( const QString &  name  ) 

Asks ibus daemon to release the given name of this connection.

Parameters:
[in] name Bus name
Returns:
0 if error happens
void IBus::Bus::removeMatch ( const QString &  rule  ) 

Removes a match rule to match message going through the bus.

Parameters:
[in] rule Match rule
Returns:
uint IBus::Bus::requestName ( const QString &  name,
uint  flag 
)

Asks ibus daemon to assign the given name to this connection.

Parameters:
[in] name Bus name
[in] flag Unused
Returns:
0 if error happens

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Enumerations Enumerator
Generated by  doxygen 1.6.2-20100208