#include <scim_property.h>
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 String & | get_key () const |
Get the key of this property. | |
const String & | get_label () const |
Get the label of this property. | |
const String & | get_icon () const |
Get the icon file of this property. | |
const String & | get_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. |
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.
|
Default constructor. Definition at line 80 of file scim_property.h. |
|
Constructor. Definition at line 85 of file scim_property.h. References SCIM_PROPERTY_ACTIVE, SCIM_PROPERTY_VISIBLE, and scim::String. |
|
Test if this property is valid.
|
|
If this property is visible.
References SCIM_PROPERTY_VISIBLE. Referenced by show(). |
|
If this property is active. A active property can be clicked by users.
References SCIM_PROPERTY_ACTIVE. |
|
Get the key of this property. Definition at line 118 of file scim_property.h. References scim::String. |
|
Get the label of this property. Definition at line 123 of file scim_property.h. References scim::String. |
|
Get the icon file of this property. Definition at line 128 of file scim_property.h. References scim::String. |
|
Get the tip of this property. Definition at line 133 of file scim_property.h. References scim::String. |
|
Set a new key for this property. Definition at line 138 of file scim_property.h. |
|
Set a new label for this property. Definition at line 143 of file scim_property.h. |
|
Set a new icon file for this property. Definition at line 148 of file scim_property.h. |
|
Set a new tip for this property. Definition at line 153 of file scim_property.h. |
|
Set if this property is active.
References SCIM_PROPERTY_ACTIVE. |
|
Definition at line 165 of file scim_property.h. References SCIM_PROPERTY_VISIBLE, and visible(). Referenced by hide(). |
|
Definition at line 170 of file scim_property.h. References show(). |
|
Test if this property is a leaf of another one.
References m_key. |