Struct IAttributes#
Defined in File core.h
Inheritance Relationships#
Derived Type#
public CAppControl(Class CAppControl)
Struct Documentation#
-
struct IAttributes#
Attribute interface.
Subclassed by CAppControl
Public Functions
-
virtual sdv::sequence<sdv::u8string> GetNames() const = 0#
Get a sequence with the available attribute names.
- Returns:
The sequence of attribute names.
-
virtual sdv::any_t Get(const sdv::u8string &ssAttribute) const = 0#
Get the attribute value.
- Parameters:
ssAttribute – [in] Name of the attribute.
- Returns:
The attribute value or an empty any-value if the attribute wasn’t found or didn’t have a value.
-
virtual bool Set(const sdv::u8string &ssAttribute, sdv::any_t anyAttribute) = 0#
Set the attribute value.
- Parameters:
ssAttribute – [in] Name of the attribute.
anyAttribute – [in] Attribute value to set.
- Returns:
Returns ‘true’ when setting the attribute was successful or ‘false’ when the attribute was not found or the attribute is read-only or another error occurred.
-
virtual uint32_t GetFlags(const sdv::u8string &ssAttribute) const = 0#
Get the attribute flags belonging to a certain attribute.
- Parameters:
ssAttribute – [in] Name of the attribute.
- Returns:
Returns the attribute flags (zero or more EAttributeFlags flags) or 0 when the attribute could not be found.
-
sequence<u8string> GetNames() const
Get a sequence with the available attribute names.
- Returns:
The sequence of attribute names.
- any Get (in u8string ssAttribute) const
Get the attribute value.
- Parameters:
ssAttribute – [in] Name of the attribute.
- Returns:
The attribute value or an empty any-value if the attribute wasn’t found or didn’t have a value.
- boolean Set (in u8string ssAttribute, in any anyAttribute)
Set the attribute value.
- Parameters:
ssAttribute – [in] Name of the attribute.
anyAttribute – [in] Attribute value to set.
- Returns:
Returns ‘true’ when setting the attribute was successful or ‘false’ when the attribute was not found or the attribute is read-only or another error occurred.
- uint32 GetFlags (in u8string ssAttribute) const
Get the attribute flags belonging to a certain attribute.
- Parameters:
ssAttribute – [in] Name of the attribute.
- Returns:
Returns the attribute flags (zero or more EAttributeFlags flags) or 0 when the attribute could not be found.
Public Static Attributes
-
static ::sdv::interface_id _id = 0x57C6485BC65354B3#
Interface ID.
-
virtual sdv::sequence<sdv::u8string> GetNames() const = 0#