Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

scim::Property Class Reference
[Helper]

Class to hold a property of a IMEngineInstance object or a Panel GUI client. More...

#include <scim_property.h>

List of all members.

Public Member Functions

 Property ()
 Default constructor.
 Property (const String &key, const String &label, const String &icon=String(""), const String &tip=String(""))
 Constructor.
bool valid () const
 Test if this property is valid.
bool visible () const
 If this property is visible.
bool active () const
 If this property is active.
const Stringget_key () const
 Get the key of this property.
const Stringget_label () const
 Get the label of this property.
const Stringget_icon () const
 Get the icon file of this property.
const Stringget_tip () const
 Get the tip of this property.
void set_key (const String &key)
 Set a new key for this property.
void set_label (const String &label)
 Set a new label for this property.
void set_icon (const String &icon)
 Set a new icon file for this property.
void set_tip (const String &tip)
 Set a new tip for this property.
void set_active (bool active)
 Set if this property is active.
void show (bool visible=true)
void hide (bool hidden=true)
bool is_a_leaf_of (const Property &node) const
 Test if this property is a leaf of another one.


Detailed Description

Class to hold a property of a IMEngineInstance object or a Panel GUI client.

A property has four elements:

With path like keys, the properties can form a cascade structure, which may be displayed like a cascading menu.

But only the top most properties can act as trigger commands and give feedback to IMEngineInstance.

Definition at line 68 of file scim_property.h.


Constructor & Destructor Documentation

scim::Property::Property  )  [inline]
 

Default constructor.

Definition at line 80 of file scim_property.h.

scim::Property::Property const String key,
const String label,
const String icon = String (""),
const String tip = String ("")
[inline]
 

Constructor.

Definition at line 85 of file scim_property.h.

References SCIM_PROPERTY_ACTIVE, SCIM_PROPERTY_VISIBLE, and scim::String.


Member Function Documentation

bool scim::Property::valid  )  const [inline]
 

Test if this property is valid.

Returns:
true if this property is valid.
Definition at line 97 of file scim_property.h.

bool scim::Property::visible  )  const [inline]
 

If this property is visible.

Returns:
true if this property is visible.
Definition at line 104 of file scim_property.h.

References SCIM_PROPERTY_VISIBLE.

Referenced by show().

bool scim::Property::active  )  const [inline]
 

If this property is active.

A active property can be clicked by users.

Returns:
true if this property is active.
Definition at line 113 of file scim_property.h.

References SCIM_PROPERTY_ACTIVE.

const String& scim::Property::get_key  )  const [inline]
 

Get the key of this property.

Definition at line 118 of file scim_property.h.

References scim::String.

const String& scim::Property::get_label  )  const [inline]
 

Get the label of this property.

Definition at line 123 of file scim_property.h.

References scim::String.

const String& scim::Property::get_icon  )  const [inline]
 

Get the icon file of this property.

Definition at line 128 of file scim_property.h.

References scim::String.

const String& scim::Property::get_tip  )  const [inline]
 

Get the tip of this property.

Definition at line 133 of file scim_property.h.

References scim::String.

void scim::Property::set_key const String key  )  [inline]
 

Set a new key for this property.

Definition at line 138 of file scim_property.h.

void scim::Property::set_label const String label  )  [inline]
 

Set a new label for this property.

Definition at line 143 of file scim_property.h.

void scim::Property::set_icon const String icon  )  [inline]
 

Set a new icon file for this property.

Definition at line 148 of file scim_property.h.

void scim::Property::set_tip const String tip  )  [inline]
 

Set a new tip for this property.

Definition at line 153 of file scim_property.h.

void scim::Property::set_active bool  active  )  [inline]
 

Set if this property is active.

Parameters:
active If this property is active.
Definition at line 160 of file scim_property.h.

References SCIM_PROPERTY_ACTIVE.

void scim::Property::show bool  visible = true  )  [inline]
 

Definition at line 165 of file scim_property.h.

References SCIM_PROPERTY_VISIBLE, and visible().

Referenced by hide().

void scim::Property::hide bool  hidden = true  )  [inline]
 

Definition at line 170 of file scim_property.h.

References show().

bool scim::Property::is_a_leaf_of const Property node  )  const [inline]
 

Test if this property is a leaf of another one.

Returns:
true if this property is a leaf of the node.
Definition at line 177 of file scim_property.h.

References m_key.


The documentation for this class was generated from the following file:
Generated on Thu Dec 30 21:03:23 2004 for scim by doxygen 1.3.8