Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Examples  

YSet Class Reference

#include <list.h>

Inheritance diagram for YSet:

Inheritance graph
[legend]
Collaboration diagram for YSet:

Collaboration graph
[legend]
List of all members.

Public Slots

void ItemChanged (YObject *)
 This slot is called every time a child emits the signal YObject::UpdateObject().


Signals

void UpdateItem (YObject *)
 Signals that a child item was changed.

void NewItem (YObject *object)
 Signals that a new child item was created and was inserted into the list.

void ItemRemoved (YObject *object)

Public Member Functions

 YSet (const CONFIG_STRING key, const QString &defaultname, const YObjectArgs &args=YObjectArgs(), YObject *p=0)
void RemoveItem (YObject *item)
void GetUniqueEntryName (QString &) const
const CONFIG_STRING GetSectionKey () const
 Return the section key for configuration issues or NULL if not set (default).

YObjectCreateNewItem (const QString &name=QString::null)
virtual int SetConfig (YInputParser &parser)
virtual int GetConfig (YOutputParser &parser)
void ClearSet ()
void SetParent (YObject *)
YObjectGetParent () const
 Returns the parent object of this list, if used.

unsigned int GetCount () const
 Returns the number of items in the list.

virtual YObjectAt (unsigned int n)
 Returns the item at index n or NULL if the item could not be found.

int FillStringList (QStringList &list, bool sort=true)
unsigned int FindItemIndex (const YObject *object)
 Returns the index number of the given object. If no object was found.


Protected Member Functions

virtual void AppendItem (YObject *object)
 This item is fully initialized and should be appended to the list.

virtual YActionsGetItemActions () const
virtual YObjectAllocNewItem (const YObjectArgs &id)=0

Private Attributes

Q_OBJECT const CONFIG_STRING sectionkey
 This is the configuration identifier e.g. "PROJECT", "EXECUTIVE".

YObjectparent
 Ptr to an parent object, which contains several lists.

QString uniquename
 This is a part of the default name e.g. "project_%1".


Detailed Description

This is the base class for lists in the application. Attention: use the function remove() to remove and delete a list entry!!! If "autodelete" is not switched on, the item will be deleted automatically if they are removed from the list!


Constructor & Destructor Documentation

YSet::YSet const CONFIG_STRING    key,
const QString &    defaultname,
const YObjectArgs   args = YObjectArgs(),
YObject   p = 0
 


Member Function Documentation

virtual YObject* YSet::AllocNewItem const YObjectArgs   id [protected, pure virtual]
 

Item will be allocated but not inserted into list. This function is provied for convenience to enable derived lists to create its own derived list objects.

Implemented in YEnvironmentSet, YLogFileTaskSet, YLogFileMutexSet, YEnvironmentLogFileSet, YMutexSet, YSchedulerPlugIns, YExecutivePlugIns, YProjectSet, YSchedulerSet, YFilePathSet, YResumeTimeSet, YResourceActionSet, and YTaskSet.

virtual void YSet::AppendItem YObject   object [inline, protected, virtual]
 

This item is fully initialized and should be appended to the list.

Reimplemented in YResumeTimeSet, and YResourceActionSet.

virtual YObject* YSet::At unsigned int    n [inline, virtual]
 

Returns the item at index n or NULL if the item could not be found.

void YSet::ClearSet  
 

YObject * YSet::CreateNewItem const QString &    n = QString::null
 

SetConfig is used here to add or configure the elements of the set. Signals "ObjectChanged" and "NewItem" will be sent

int YSet::FillStringList QStringList &    list,
bool    sort = true
 

Fills the given string list with the names of the list item. There are strings returned by GetName() used.

unsigned int YSet::FindItemIndex const YObject   object [inline]
 

Returns the index number of the given object. If no object was found.

virtual int YSet::GetConfig YOutputParser   parser [inline, virtual]
 

Reimplemented from YObject.

unsigned int YSet::GetCount   const [inline]
 

Returns the number of items in the list.

virtual YActions* YSet::GetItemActions   const [inline, protected, virtual]
 

This function is provided for convenience to get the YAction Ptr of derived lists during CreateNewItem(). Default=0

Reimplemented in YEnvironmentSet, YMutexSet, YProjectSet, YSchedulerSet, YFilePathSet, and YTaskSet.

YObject* YSet::GetParent   const [inline]
 

Returns the parent object of this list, if used.

const CONFIG_STRING YSet::GetSectionKey   const [inline]
 

Return the section key for configuration issues or NULL if not set (default).

void YSet::GetUniqueEntryName QString &    const
 

void YSet::ItemChanged YObject   object [slot]
 

This slot is called every time a child emits the signal YObject::UpdateObject().

This is a slot which is called after changing an item in this list. It sends the signal "UpdateItem(YObject *item)" first and then UpdateObject(YSet *this) to signal a change of the whole list It is not called after creating or destroying an item!

void YSet::ItemRemoved YObject   object [signal]
 

Signals that a child item should be destroyed. Currently the item is already in list and will be removed and destroyed if the signal handling is completed

void YSet::NewItem YObject   object [signal]
 

Signals that a new child item was created and was inserted into the list.

void YSet::RemoveItem YObject   object
 

Items will not be deleted here. Maybe they will be deleted during qlist::remove() due to switching on autodelete Signals "ItemRemoved" will be called before destroying the item and "ObjectChanged" will be called after destroying the object

virtual int YSet::SetConfig YInputParser   parser [inline, virtual]
 

Reimplemented from YObject.

void YSet::SetParent YObject  
 

void YSet::UpdateItem YObject   [signal]
 

Signals that a child item was changed.


Member Data Documentation

YObject* YSet::parent [private]
 

Ptr to an parent object, which contains several lists.

Q_OBJECT const CONFIG_STRING YSet::sectionkey [private]
 

This is the configuration identifier e.g. "PROJECT", "EXECUTIVE".

QString YSet::uniquename [private]
 

This is a part of the default name e.g. "project_%1".


The documentation for this class was generated from the following files:
Generated on Fri Feb 14 00:02:41 2003 for Yasa by doxygen1.3-rc3