#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 leaf properties can act as trigger commands and give feedback to IMEngineInstance.
All strings should be encoded into UTF-8.
| scim::Property::Property | ( | ) | [inline] |
Default constructor.
| scim::Property::Property | ( | const String & | key, | |
| const String & | label, | |||
| const String & | icon = String (""), |
|||
| const String & | tip = String ("") | |||
| ) | [inline] |
Constructor.
| bool scim::Property::valid | ( | ) | const [inline] |
Test if this property is valid.
| bool scim::Property::visible | ( | ) | const [inline] |
If this property is visible.
| bool scim::Property::active | ( | ) | const [inline] |
If this property is active.
A active property can be clicked by users.
| const String& scim::Property::get_key | ( | ) | const [inline] |
Get the key of this property.
| const String& scim::Property::get_label | ( | ) | const [inline] |
Get the label of this property.
| const String& scim::Property::get_icon | ( | ) | const [inline] |
Get the icon file of this property.
| const String& scim::Property::get_tip | ( | ) | const [inline] |
Get the tip of this property.
| void scim::Property::set_key | ( | const String & | key | ) | [inline] |
Set a new key for this property.
| void scim::Property::set_label | ( | const String & | label | ) | [inline] |
Set a new label for this property.
| void scim::Property::set_icon | ( | const String & | icon | ) | [inline] |
Set a new icon file for this property.
| void scim::Property::set_tip | ( | const String & | tip | ) | [inline] |
Set a new tip for this property.
| void scim::Property::set_active | ( | bool | active | ) | [inline] |
Set if this property is active.
| active | If this property is active. |
| void scim::Property::show | ( | bool | visible = true |
) | [inline] |
| void scim::Property::hide | ( | bool | hidden = true |
) | [inline] |
| bool scim::Property::is_a_leaf_of | ( | const Property & | node | ) | const [inline] |
Test if this property is a leaf of another one.
1.5.0