scim
1.4.18
|
Class to hold a property of a IMEngineInstance object or a Panel GUI client. More...
#include <scim_property.h>
Public Member Functions | |
Property () | |
Default constructor. More... | |
Property (const String &key, const String &label, const String &icon=String(""), const String &tip=String("")) | |
Constructor. More... | |
bool | valid () const |
Test if this property is valid. More... | |
bool | visible () const |
If this property is visible. More... | |
bool | active () const |
If this property is active. More... | |
const String & | get_key () const |
Get the key of this property. More... | |
const String & | get_label () const |
Get the label of this property. More... | |
const String & | get_icon () const |
Get the icon file of this property. More... | |
const String & | get_tip () const |
Get the tip of this property. More... | |
void | set_key (const String &key) |
Set a new key for this property. More... | |
void | set_label (const String &label) |
Set a new label for this property. More... | |
void | set_icon (const String &icon) |
Set a new icon file for this property. More... | |
void | set_tip (const String &tip) |
Set a new tip for this property. More... | |
void | set_active (bool active) |
Set if this property is active. More... | |
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. More... | |
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 leaf properties can act as trigger commands and give feedback to IMEngineInstance.
All strings should be encoded into UTF-8.
|
inline |
Default constructor.
|
inline |
Constructor.
|
inline |
Test if this property is valid.
|
inline |
If this property is visible.
References SCIM_PROPERTY_VISIBLE.
Referenced by show().
|
inline |
If this property is active.
A active property can be clicked by users.
References SCIM_PROPERTY_ACTIVE.
Referenced by set_active().
|
inline |
Get the key of this property.
Referenced by scim::operator!=(), scim::operator<(), and scim::operator==().
|
inline |
Get the label of this property.
|
inline |
Get the icon file of this property.
|
inline |
Get the tip of this property.
|
inline |
Set a new key for this property.
|
inline |
Set a new label for this property.
|
inline |
Set a new icon file for this property.
|
inline |
Set a new tip for this property.
|
inline |
Set if this property is active.
active | If this property is active. |
References active(), and SCIM_PROPERTY_ACTIVE.
|
inline |
References SCIM_PROPERTY_VISIBLE, and visible().
Referenced by hide().
|
inline |
References show().
|
inline |
Test if this property is a leaf of another one.