kitchensync

QSync::Member Class Reference

List of all members.


Detailed Description

Definition at line 33 of file member.h.


Public Member Functions

 Member ()
 ~Member ()
bool isValid () const
QString configurationDirectory () const
QString pluginName () const
Plugin plugin () const
int id () const
void setName (const QString &name)
QString name () const
void setConfiguration (const QByteArray &configurationData)
Result configuration (QByteArray &configurationData, bool useDefault=true)
Result save ()
Result instance (const Plugin &)
bool operator== (const Member &) const
QString scanDevices (const QString &query)
bool testConnection (const QString &configuration)

Friends

class Group
class SyncChange
class SyncMemberUpdate

Member Function Documentation

bool Member::isValid (  )  const

Returns whether the member object is valid.

Definition at line 38 of file member.cpp.

QString Member::configurationDirectory (  )  const

Returns the configuration directory.

Definition at line 54 of file member.cpp.

QString Member::pluginName (  )  const

Returns the name of the plugin, the member belongs to.

Definition at line 61 of file member.cpp.

Plugin Member::plugin (  )  const

Returns the plugin, the member belongs to.

Definition at line 68 of file member.cpp.

int Member::id (  )  const

Returns the id of the plugin.

Definition at line 81 of file member.cpp.

void Member::setName ( const QString &  name  ) 

Sets the name of this member.

Definition at line 88 of file member.cpp.

QString Member::name (  )  const

Returns the name of this member.

Definition at line 95 of file member.cpp.

void Member::setConfiguration ( const QByteArray &  configurationData  ) 

Sets the configuration data as byte array.

The developer has to decide the type of the data ( e.g. xml, plain text, binary ).

Definition at line 102 of file member.cpp.

Result Member::configuration ( QByteArray &  configurationData,
bool  useDefault = true 
)

Gets the configuration data as byte array.

The developer has to decide the type of the data ( e.g. xml, plain text, binary ).

Parameters:
useDefault If set to true, return default config, if no config exists. If set to false, return error when no config exists.
Returns:
The result of this operation.

Definition at line 109 of file member.cpp.

Result Member::save (  ) 

Saves the changes to the configuration to hard disc.

Definition at line 133 of file member.cpp.

Result Member::instance ( const Plugin plugin  ) 

Make this member an instance of the given plugin.

Definition at line 144 of file member.cpp.

QString Member::scanDevices ( const QString &  query  ) 

This method can be used to query the plugin for scanning devices.

The

Parameters:
query is a plugin specific xml document as well as the return value.

Definition at line 158 of file member.cpp.

bool Member::testConnection ( const QString &  configuration  ) 

This method can be used to test whether the plugin can connect to the device with the given configuration.

Definition at line 174 of file member.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys