Struct EditorInfo

pub struct EditorInfo(/* private fields */);

Editor information for metadata.

Metadata in metaclasses, property types and message types may contain information for Kanzi Studio. This information may include tooltips, default values and so on.

Implementations

impl EditorInfo

pub const fn as_ptr(&self) -> *mut EditorInfoWrapper

impl EditorInfo

pub fn create() -> Result<EditorInfo, Error>

Creates a new instance of EditorInfo.

pub fn set_attribute( &self, key: impl AsRef<KanziStr>, value: impl AsRef<KanziStr>, ) -> Result<(), Error>

Sets a custom attribute.

pub fn set_display_name(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets friendly display name used in Kanzi Studio.

pub fn set_tooltip(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets tooltip used in Kanzi Studio.

pub fn set_category(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets category name used in Kanzi Studio.

pub fn set_help_heading(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets help heading used in Kanzi Studio.

pub fn set_value_provider( &self, value: impl AsRef<KanziStr>, ) -> Result<(), Error>

Sets value provider used in Kanzi Studio.

pub fn set_host(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets host definition that defines object types for which Kanzi Studio suggests the property.

pub fn set_editor(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets editor type used in Kanzi Studio.

pub fn set_default_value( &self, value: impl AsRef<KanziStr>, ) -> Result<(), Error>

Sets default value for the property.

pub fn set_lower_bound(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets lowest value the property can have.

pub fn set_upper_bound(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets highest value the property can have.

pub fn set_step(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets amount by which the property value changes when a Kanzi Studio user edits it.

pub fn set_sendable(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets whether Kanzi Studio shows the message as an action.

pub fn set_listenable(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets whether Kanzi Studio shows the message as a trigger.

pub fn set_studio_visibility( &self, value: impl AsRef<KanziStr>, ) -> Result<(), Error>

Sets whether the property or message is available in Kanzi Studio.

pub fn set_legacy_name(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

Sets the property’s old name.

pub fn set_sorting_index( &self, value: impl AsRef<KanziStr>, ) -> Result<(), Error>

Sets position of the property within its property category in Kanzi Studio.

pub fn get_attribute( &self, key: impl AsRef<KanziStr>, ) -> Result<KanziString, Error>

Gets a custom attribute.

pub fn get_display_name(&self) -> Result<KanziString, Error>

Gets friendly display name used in Kanzi Studio.

pub fn get_tooltip(&self) -> Result<KanziString, Error>

Gets tooltip used in Kanzi Studio.

pub fn get_category(&self) -> Result<KanziString, Error>

Gets category name used in Kanzi Studio.

pub fn get_help_heading(&self) -> Result<KanziString, Error>

Gets help heading used in Kanzi Studio.

pub fn get_value_provider(&self) -> Result<KanziString, Error>

Gets value provider used in Kanzi Studio.

pub fn get_host(&self) -> Result<KanziString, Error>

Gets host definition that defines object types for which Kanzi Studio suggests the property.

pub fn get_editor(&self) -> Result<KanziString, Error>

Gets editor type used in Kanzi Studio.

pub fn get_default_value(&self) -> Result<KanziString, Error>

Gets default value for the property.

pub fn get_lower_bound(&self) -> Result<KanziString, Error>

Gets lowest value the property can have.

pub fn get_upper_bound(&self) -> Result<KanziString, Error>

Gets highest value the property can have.

pub fn get_step(&self) -> Result<KanziString, Error>

Gets amount by which the property value changes when a Kanzi Studio user edits it.

pub fn get_sendable(&self) -> Result<KanziString, Error>

Gets whether Kanzi Studio shows the message as an action.

pub fn get_listenable(&self) -> Result<KanziString, Error>

Gets whether Kanzi Studio shows the message as a trigger.

pub fn get_studio_visibility(&self) -> Result<KanziString, Error>

Gets whether the property or message is available in Kanzi Studio.

pub fn get_legacy_name(&self) -> Result<KanziString, Error>

Gets the property’s old name.

pub fn get_sorting_index(&self) -> Result<KanziString, Error>

Gets position of the property within its property category in Kanzi Studio.

Trait Implementations

impl Drop for EditorInfo

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for EditorInfo

fn eq(&self, rhs: &EditorInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EditorInfo