Struct TextBoxConcept

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

Implementations

impl TextBoxConcept

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

See: DISPLAY_TEXT_PROPERTY

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

See: DISPLAY_TEXT_PROPERTY

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

See: COMPOSITION_TEXT_PROPERTY

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

See: COMPOSITION_TEXT_PROPERTY

pub fn get_selection_background_brush( &self, ) -> Result<Option<Weak<Resource>>, Error>

See: SELECTION_BACKGROUND_BRUSH_PROPERTY

pub fn set_selection_background_brush( &self, value: Option<&Resource>, ) -> Result<(), Error>

See: SELECTION_BACKGROUND_BRUSH_PROPERTY

pub fn get_selection_foreground_brush( &self, ) -> Result<Option<Weak<Resource>>, Error>

See: SELECTION_FOREGROUND_BRUSH_PROPERTY

pub fn set_selection_foreground_brush( &self, value: Option<&Resource>, ) -> Result<(), Error>

See: SELECTION_FOREGROUND_BRUSH_PROPERTY

pub fn get_composition_text_background_brush( &self, ) -> Result<Option<Weak<Resource>>, Error>

See: COMPOSITION_TEXT_BACKGROUND_BRUSH_PROPERTY

pub fn set_composition_text_background_brush( &self, value: Option<&Resource>, ) -> Result<(), Error>

See: COMPOSITION_TEXT_BACKGROUND_BRUSH_PROPERTY

pub fn get_composition_text_foreground_brush( &self, ) -> Result<Option<Weak<Resource>>, Error>

See: COMPOSITION_TEXT_FOREGROUND_BRUSH_PROPERTY

pub fn set_composition_text_foreground_brush( &self, value: Option<&Resource>, ) -> Result<(), Error>

See: COMPOSITION_TEXT_FOREGROUND_BRUSH_PROPERTY

pub fn get_cursor_position(&self) -> Result<i32, Error>

See: CURSOR_POSITION_PROPERTY

pub fn set_cursor_position(&self, value: i32) -> Result<(), Error>

See: CURSOR_POSITION_PROPERTY

pub fn get_selection_start_cursor_position(&self) -> Result<i32, Error>

See: SELECTION_START_CURSOR_POSITION_PROPERTY

pub fn set_selection_start_cursor_position( &self, value: i32, ) -> Result<(), Error>

See: SELECTION_START_CURSOR_POSITION_PROPERTY

pub fn get_selection_end_cursor_position(&self) -> Result<i32, Error>

See: SELECTION_END_CURSOR_POSITION_PROPERTY

pub fn set_selection_end_cursor_position(&self, value: i32) -> Result<(), Error>

See: SELECTION_END_CURSOR_POSITION_PROPERTY

pub fn get_has_selection(&self) -> Result<bool, Error>

See: HAS_SELECTION_PROPERTY

pub fn set_has_selection(&self, value: bool) -> Result<(), Error>

See: HAS_SELECTION_PROPERTY

pub fn get_read_only(&self) -> Result<bool, Error>

See: READ_ONLY_PROPERTY

pub fn set_read_only(&self, value: bool) -> Result<(), Error>

See: READ_ONLY_PROPERTY

pub fn get_maximum_text_length(&self) -> Result<i32, Error>

See: MAXIMUM_TEXT_LENGTH_PROPERTY

pub fn set_maximum_text_length(&self, value: i32) -> Result<(), Error>

See: MAXIMUM_TEXT_LENGTH_PROPERTY

pub fn get_cursor_prefab(&self) -> Result<Option<Weak<Resource>>, Error>

See: CURSOR_PREFAB_PROPERTY

pub fn set_cursor_prefab(&self, value: Option<&Resource>) -> Result<(), Error>

See: CURSOR_PREFAB_PROPERTY

pub fn get_selection_start_prefab( &self, ) -> Result<Option<Weak<Resource>>, Error>

See: SELECTION_START_PREFAB_PROPERTY

pub fn set_selection_start_prefab( &self, value: Option<&Resource>, ) -> Result<(), Error>

See: SELECTION_START_PREFAB_PROPERTY

pub fn get_selection_end_prefab(&self) -> Result<Option<Weak<Resource>>, Error>

See: SELECTION_END_PREFAB_PROPERTY

pub fn set_selection_end_prefab( &self, value: Option<&Resource>, ) -> Result<(), Error>

See: SELECTION_END_PREFAB_PROPERTY

pub fn get_text_hint_prefab(&self) -> Result<Option<Weak<Resource>>, Error>

See: TEXT_HINT_PREFAB_PROPERTY

pub fn set_text_hint_prefab( &self, value: Option<&Resource>, ) -> Result<(), Error>

See: TEXT_HINT_PREFAB_PROPERTY

pub fn get_hide_text_hint_when_editing(&self) -> Result<bool, Error>

See: HIDE_TEXT_HINT_WHEN_EDITING_PROPERTY

pub fn set_hide_text_hint_when_editing(&self, value: bool) -> Result<(), Error>

See: HIDE_TEXT_HINT_WHEN_EDITING_PROPERTY

pub fn get_echo_mode(&self) -> Result<EchoMode, Error>

See: ECHO_MODE_PROPERTY

pub fn set_echo_mode(&self, value: EchoMode) -> Result<(), Error>

See: ECHO_MODE_PROPERTY

pub fn get_input_type(&self) -> Result<InputType, Error>

See: INPUT_TYPE_PROPERTY

pub fn set_input_type(&self, value: InputType) -> Result<(), Error>

See: INPUT_TYPE_PROPERTY

pub fn get_edit_mode(&self) -> Result<EditMode, Error>

See: EDIT_MODE_PROPERTY

pub fn set_edit_mode(&self, value: EditMode) -> Result<(), Error>

See: EDIT_MODE_PROPERTY

pub fn get_is_editing(&self) -> Result<bool, Error>

See: IS_EDITING_PROPERTY

pub fn set_is_editing(&self, value: bool) -> Result<(), Error>

See: IS_EDITING_PROPERTY

pub fn get_is_composing_text(&self) -> Result<bool, Error>

See: IS_COMPOSING_TEXT_PROPERTY

pub fn set_is_composing_text(&self, value: bool) -> Result<(), Error>

See: IS_COMPOSING_TEXT_PROPERTY

pub fn get_character_count(&self) -> Result<i32, Error>

See: CHARACTER_COUNT_PROPERTY

pub fn set_character_count(&self, value: i32) -> Result<(), Error>

See: CHARACTER_COUNT_PROPERTY

pub fn get_word_count(&self) -> Result<i32, Error>

See: WORD_COUNT_PROPERTY

pub fn set_word_count(&self, value: i32) -> Result<(), Error>

See: WORD_COUNT_PROPERTY

pub fn get_password_echo_timeout(&self) -> Result<i32, Error>

See: PASSWORD_ECHO_TIMEOUT_PROPERTY

pub fn set_password_echo_timeout(&self, value: i32) -> Result<(), Error>

See: PASSWORD_ECHO_TIMEOUT_PROPERTY

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

See: PASSWORD_MASKING_CHARACTER_PROPERTY

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

See: PASSWORD_MASKING_CHARACTER_PROPERTY

pub fn get_input_method_action(&self) -> Result<InputMethodAction, Error>

See: INPUT_METHOD_ACTION_PROPERTY

pub fn set_input_method_action( &self, value: InputMethodAction, ) -> Result<(), Error>

See: INPUT_METHOD_ACTION_PROPERTY

pub fn get_text_key_navigation_direction( &self, ) -> Result<TextKeyNavigationDirection, Error>

See: TEXT_KEY_NAVIGATION_DIRECTION_PROPERTY

pub fn set_text_key_navigation_direction( &self, value: TextKeyNavigationDirection, ) -> Result<(), Error>

See: TEXT_KEY_NAVIGATION_DIRECTION_PROPERTY

Methods from Deref<Target = Object>

pub fn as_ptr(&self) -> *mut ObjectWrapper

pub fn as_wrapper(&self) -> &ObjectWrapper

pub fn as_object(&self) -> &Object

Represents any type inheriting from Object as &Object. This is useful for comparisions when PartialEq traits failed to compare objects of different types.

let child = screen.get_child(0)?;
let parent = child.get_parent()?.into_error(ErrorKind::ObjectNotFound)?;
// assert_eq!(screen, parent); // <- Fails to compile!
assert_eq!(screen.as_object(), parent.as_object());

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

pub fn is_stale(&self) -> bool

Checks whether the weak reference has expired.

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers.

Base value is affected by the following inputs where the highest entry in the list determines the base value:

1. Local value set with setProperty or loaded from kzb
2. Value set by a style affecting the property.
3. Value defined by class metadata.

Modifiers are not applied, the highest-priority base value is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

If there is no value sources, None is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the local value of a property type.

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>

where T: PropertyTypeConstraint,

Evaluates whether there are any inputs into the property value. Both value sources and modifiers are taken into account.

Returns

Returns true if there are inputs into the property value, false otherwise.

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Removes the local value associated with the property.

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

Returns the metaclass of the dynamic type of the object.

pub fn get_domain(&self) -> Result<Domain, Error>

Returns the domain the object belongs to.

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the flag to indicate that the property was loaded from KZB.

pub fn debug_string(&self) -> Result<String, Error>

Builds a string representation of the object intended for debugging purposes.

Trait Implementations

impl Clone for TextBoxConcept

fn clone(&self) -> TextBoxConcept

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextBoxConcept

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for TextBoxConcept

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &<TextBoxConcept as Deref>::Target

Dereferences the value.

impl Inheritable for TextBoxConcept

unsafe fn downcast_unchecked<T>(self) -> T

where T: Inherits<Self>,

Downcast the object to a more specific type.

unsafe fn downcast_unchecked_ref<T>(&self) -> &T

where T: Inherits<Self>,

Downcast the object reference to a more specific type.

impl Inherits<Object> for TextBoxConcept

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<TextBoxConcept> for TextBox2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<TextBoxConcept> for TextBox3D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for TextBoxConcept

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for TextBoxConcept

fn downcast<T>(self) -> Result<Option<T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by value.

fn downcast_ref<T>(&self) -> Result<Option<&T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by reference.

fn is_a<T>(&self) -> Result<bool, Error>

where T: MetaInherits<Self>,

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

fn downgrade(self) -> Weak<Self>

fn downgrade_ref(&self) -> Weak<Self>

fn lock(self) -> ThreadObject<Self>

fn lock_ref(&self) -> ThreadObject<Self>

impl<T> PartialEq<T> for TextBoxConcept

where T: ObjectConstraint,

fn eq(&self, rhs: &T) -> 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<T> PartialEq<Weak<T>> for TextBoxConcept

where T: ObjectConstraint,

fn eq(&self, rhs: &Weak<T>) -> 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 TextBoxConcept