kitchensync

QSync::Group Class Reference

List of all members.


Detailed Description

Definition at line 53 of file group.h.


Public Types

enum  LockType { LockOk, Locked, LockStale }

Public Member Functions

 Group ()
 ~Group ()
bool isValid () const
Iterator begin ()
Iterator end ()
void setName (const QString &name)
QString name () const
void setLastSynchronization (const QDateTime &dateTime)
QDateTime lastSynchronization () const
LockType lock ()
void unlock (bool removeFile=true)
Member addMember ()
void removeMember (const Member &member)
int memberCount () const
Member memberAt (int pos) const
int filterCount () const
Filter filterAt (int pos)
void setObjectTypeEnabled (const QString &objectType, bool enabled)
bool isObjectTypeEnabled (const QString &objectType) const
Result save ()
GroupConfig config () const
bool operator== (const Group &group) const

Friends

class Engine
class Environment

Classes

class  Iterator

Member Enumeration Documentation

Enumerator:
LockOk 
Locked 
LockStale 

Definition at line 59 of file group.h.


Member Function Documentation

bool Group::isValid (  )  const

Returns whether the object is a valid group.

Definition at line 117 of file group.cpp.

Group::Iterator Group::begin (  ) 

Returns an iterator pointing to the first item in the member list.

This iterator equals end() if the member list is empty.

Definition at line 122 of file group.cpp.

Group::Iterator Group::end (  ) 

Returns an iterator pointing past the last item in the member list.

This iterator equals begin() if the member list is empty.

Definition at line 130 of file group.cpp.

void Group::setName ( const QString &  name  ) 

Sets the name of the group.

Definition at line 138 of file group.cpp.

QString Group::name (  )  const

Returns the name of the group.

Definition at line 145 of file group.cpp.

void Group::setLastSynchronization ( const QDateTime &  dateTime  ) 

Sets the time of the last successfull synchronization.

Definition at line 152 of file group.cpp.

QDateTime Group::lastSynchronization (  )  const

Returns the time of the last successfull synchronization.

Definition at line 160 of file group.cpp.

Group::LockType Group::lock (  ) 

Locks the group.

Returns:
The the result of the locking request.

Definition at line 172 of file group.cpp.

void Group::unlock ( bool  removeFile = true  ) 

Unlocks the group.

Parameters:
removeFile Whether the lock file shall be removed.

Definition at line 191 of file group.cpp.

Member Group::addMember (  ) 

Adds a new member to the group.

Returns:
the new member.

Definition at line 198 of file group.cpp.

void Group::removeMember ( const Member member  ) 

Removes a member from the group.

Definition at line 212 of file group.cpp.

int Group::memberCount (  )  const

Returns the number of members.

Definition at line 219 of file group.cpp.

Member Group::memberAt ( int  pos  )  const

Returns the member at position.

Parameters:
pos. 

Definition at line 226 of file group.cpp.

int Group::filterCount (  )  const

Returns the number of filters.

Definition at line 240 of file group.cpp.

Filter Group::filterAt ( int  pos  ) 

Returns the filter at position.

Parameters:
pos. 

Definition at line 247 of file group.cpp.

void Group::setObjectTypeEnabled ( const QString &  objectType,
bool  enabled 
)

Set, if the object type with given name is enabled for synchronisation for this group.

Definition at line 272 of file group.cpp.

bool Group::isObjectTypeEnabled ( const QString &  objectType  )  const

Returns whether the object type with given name is enabled for synchronisation for this group.

Definition at line 279 of file group.cpp.

Result Group::save (  ) 

Saves the configuration to hard disc.

Definition at line 261 of file group.cpp.

GroupConfig Group::config (  )  const

Returns the config object of this group.

Note: This method is only available for OpenSync 0.19 and 0.20.

Definition at line 284 of file group.cpp.


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