• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • KDevelop Property Editing Library
 

KDevelop Property Editing Library

  • PropertyLib
  • PropertyList
Public Types | Signals | Public Member Functions | Protected Member Functions | Friends | List of all members
PropertyLib::PropertyList Class Reference

#include <propertylist.h>

Inheritance diagram for PropertyLib::PropertyList:
PropertyLib::PropertyBuffer

Public Types

typedef Iterator iterator
 

Signals

void propertyValueChanged (Property *property)
 
void aboutToDeleteProperty (Property *property)
 

Public Member Functions

virtual MultiProperty * operator[] (const TQString &name)
 
MultiProperty * property (const TQString &name)
 
virtual void addProperty (Property *property)
 
virtual void addProperty (const TQString &group, Property *property)
 
virtual void removeProperty (Property *property)
 
virtual void removeProperty (const TQString &name)
 
virtual const TQValueList< TQPair< TQString, TQValueList< TQString > > > & propertiesOfGroup () const
 
virtual const TQMap< MultiProperty *, TQString > & groupOfProperty () const
 
virtual void clear ()
 
virtual bool contains (const TQString &name)
 
TQPtrList< Property > properties (const TQString &name)
 
Iterator begin ()
 
Iterator end ()
 

Protected Member Functions

 PropertyList (bool propertyOwner)
 
void addToGroup (const TQString &group, MultiProperty *property)
 
void removeFromGroup (MultiProperty *property)
 

Friends

class MultiProperty
 
class PropertyBuffer
 
class Iterator
 

Detailed Description

The list of properties.

Every object in a program should operate with properties through this list in order to:

  • be informed about property changes
  • allow property lists intersections
  • display properties in the property editor widget (see PropertyLib::PropertyEditor).

PropertyList owns properties and deletes them itself. For a list that does not own it's properties, look at PropertyLib::PropertyBuffer class.

PropertyList is also capable of grouping properties. You can have unsorted list of groups of properties or a plain alphabetically sorted list of properties or both at the same time.

Definition at line 55 of file propertylist.h.

Constructor & Destructor Documentation

◆ PropertyList()

PropertyLib::PropertyList::PropertyList ( bool  propertyOwner)
protected

Constructs a list which owns or does not own it's properties.

Definition at line 32 of file propertylist.cpp.

Member Function Documentation

◆ aboutToDeleteProperty

void PropertyLib::PropertyList::aboutToDeleteProperty ( Property *  property)
signal

Emitted when property is about to be deleted.

◆ addProperty() [1/2]

void PropertyLib::PropertyList::addProperty ( Property *  property)
virtual

Adds the property to the list to the "common" group.

Definition at line 58 of file propertylist.cpp.

◆ addProperty() [2/2]

void PropertyLib::PropertyList::addProperty ( const TQString &  group,
Property *  property 
)
virtual

Adds the property to the list in group.

Definition at line 76 of file propertylist.cpp.

◆ addToGroup()

void PropertyLib::PropertyList::addToGroup ( const TQString &  group,
MultiProperty *  property 
)
protected

Adds property to a group.

Definition at line 159 of file propertylist.cpp.

◆ clear()

void PropertyLib::PropertyList::clear ( )
virtual

Clears the list of properties.

Definition at line 214 of file propertylist.cpp.

◆ contains()

bool PropertyLib::PropertyList::contains ( const TQString &  name)
virtual

Returns true if the list of properties contains property with given name.

Definition at line 220 of file propertylist.cpp.

◆ groupOfProperty()

const TQMap< MultiProperty *, TQString > & PropertyLib::PropertyList::groupOfProperty ( ) const
virtual
Returns
the map: property - group name.

Definition at line 154 of file propertylist.cpp.

◆ operator[]()

MultiProperty * PropertyLib::PropertyList::operator[] ( const TQString &  name)
virtual

Accesses a property by it's name.

All property modifications are allowed trough this method. For example, to set a value of a property, use: /code PropertyList list; ... list["My Property"]->setValue("My Value"); /endcode

Returns
MultiProperty with given name.

Definition at line 42 of file propertylist.cpp.

◆ properties()

TQPtrList< Property > PropertyLib::PropertyList::properties ( const TQString &  name)

The list of properties with given name.

Definition at line 227 of file propertylist.cpp.

◆ propertiesOfGroup()

const TQValueList< TQPair< TQString, TQValueList< TQString > > > & PropertyLib::PropertyList::propertiesOfGroup ( ) const
virtual
Returns
the list of grouped properties.

Definition at line 149 of file propertylist.cpp.

◆ property()

MultiProperty * PropertyLib::PropertyList::property ( const TQString &  name)

Accesses a property by it's name.

All property modifications are allowed trough this method. For example, to set a value of a property

Definition at line 50 of file propertylist.cpp.

◆ propertyValueChanged

void PropertyLib::PropertyList::propertyValueChanged ( Property *  property)
signal

Emitted when the value of the property is changed.

◆ removeFromGroup()

void PropertyLib::PropertyList::removeFromGroup ( MultiProperty *  property)
protected

Removes property from a group.

Definition at line 194 of file propertylist.cpp.

◆ removeProperty() [1/2]

void PropertyLib::PropertyList::removeProperty ( Property *  property)
virtual

Removes property from the list.

Emits aboutToDeleteProperty before removing.

Definition at line 95 of file propertylist.cpp.

◆ removeProperty() [2/2]

void PropertyLib::PropertyList::removeProperty ( const TQString &  name)
virtual

Removes property with the given name from the list.

Emits aboutToDeleteProperty before removing.

Definition at line 120 of file propertylist.cpp.


The documentation for this class was generated from the following files:
  • propertylist.h
  • propertylist.cpp

KDevelop Property Editing Library

Skip menu "KDevelop Property Editing Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

KDevelop Property Editing Library

Skip menu "KDevelop Property Editing Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for KDevelop Property Editing Library by doxygen 1.8.13
This website is maintained by Timothy Pearson.