Struct ScrollViewConcept

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

Implementations

impl ScrollViewConcept

pub fn get_recognition_threshold(&self) -> Result<f32, Error>

See: RECOGNITION_THRESHOLD_PROPERTY

pub fn set_recognition_threshold(&self, value: f32) -> Result<(), Error>

See: RECOGNITION_THRESHOLD_PROPERTY

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

See: MINIMUM_NUMBER_OF_TOUCHES_PROPERTY

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

See: MINIMUM_NUMBER_OF_TOUCHES_PROPERTY

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

See: MAXIMUM_NUMBER_OF_TOUCHES_PROPERTY

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

See: MAXIMUM_NUMBER_OF_TOUCHES_PROPERTY

pub fn get_sensitivity(&self) -> Result<f32, Error>

See: SENSITIVITY_PROPERTY

pub fn set_sensitivity(&self, value: f32) -> Result<(), Error>

See: SENSITIVITY_PROPERTY

pub fn get_sliding_acceleration_coefficient(&self) -> Result<f32, Error>

See: SLIDING_ACCELERATION_COEFFICIENT_PROPERTY

pub fn set_sliding_acceleration_coefficient( &self, value: f32, ) -> Result<(), Error>

See: SLIDING_ACCELERATION_COEFFICIENT_PROPERTY

pub fn get_sliding_drag_coefficient(&self) -> Result<f32, Error>

See: SLIDING_DRAG_COEFFICIENT_PROPERTY

pub fn set_sliding_drag_coefficient(&self, value: f32) -> Result<(), Error>

See: SLIDING_DRAG_COEFFICIENT_PROPERTY

pub fn get_dragging_acceleration_coefficient(&self) -> Result<f32, Error>

See: DRAGGING_ACCELERATION_COEFFICIENT_PROPERTY

pub fn set_dragging_acceleration_coefficient( &self, value: f32, ) -> Result<(), Error>

See: DRAGGING_ACCELERATION_COEFFICIENT_PROPERTY

pub fn get_dragging_drag_coefficient(&self) -> Result<f32, Error>

See: DRAGGING_DRAG_COEFFICIENT_PROPERTY

pub fn set_dragging_drag_coefficient(&self, value: f32) -> Result<(), Error>

See: DRAGGING_DRAG_COEFFICIENT_PROPERTY

pub fn get_dragging_impulse_factor(&self) -> Result<f32, Error>

See: DRAGGING_IMPULSE_FACTOR_PROPERTY

pub fn set_dragging_impulse_factor(&self, value: f32) -> Result<(), Error>

See: DRAGGING_IMPULSE_FACTOR_PROPERTY

pub fn get_swipe_distance(&self) -> Result<f32, Error>

See: SWIPE_DISTANCE_PROPERTY

pub fn set_swipe_distance(&self, value: f32) -> Result<(), Error>

See: SWIPE_DISTANCE_PROPERTY

pub fn get_scroll_position(&self) -> Result<Vector2, Error>

See: SCROLL_POSITION_PROPERTY

pub fn set_scroll_position(&self, value: Vector2) -> Result<(), Error>

See: SCROLL_POSITION_PROPERTY

pub fn get_scroll_target_position(&self) -> Result<Vector2, Error>

See: SCROLL_TARGET_POSITION_PROPERTY

pub fn set_scroll_target_position(&self, value: Vector2) -> Result<(), Error>

See: SCROLL_TARGET_POSITION_PROPERTY

pub fn get_scroll_speed(&self) -> Result<Vector2, Error>

See: SCROLL_SPEED_PROPERTY

pub fn set_scroll_speed(&self, value: Vector2) -> Result<(), Error>

See: SCROLL_SPEED_PROPERTY

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

See: SCROLLING_PROPERTY

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

See: SCROLLING_PROPERTY

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

See: ZOOM_AFFECTS_SCROLLING_PROPERTY

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

See: ZOOM_AFFECTS_SCROLLING_PROPERTY

pub fn get_scroll_bounds_minimum(&self) -> Result<Vector2, Error>

See: SCROLL_BOUNDS_MINIMUM_PROPERTY

pub fn set_scroll_bounds_minimum(&self, value: Vector2) -> Result<(), Error>

See: SCROLL_BOUNDS_MINIMUM_PROPERTY

pub fn get_scroll_bounds_maximum(&self) -> Result<Vector2, Error>

See: SCROLL_BOUNDS_MAXIMUM_PROPERTY

pub fn set_scroll_bounds_maximum(&self, value: Vector2) -> Result<(), Error>

See: SCROLL_BOUNDS_MAXIMUM_PROPERTY

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

See: LOOPING_X_ENABLED_PROPERTY

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

See: LOOPING_X_ENABLED_PROPERTY

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

See: LOOPING_Y_ENABLED_PROPERTY

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

See: LOOPING_Y_ENABLED_PROPERTY

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

See: ZOOM_ENABLED_PROPERTY

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

See: ZOOM_ENABLED_PROPERTY

pub fn get_zoom(&self) -> Result<f32, Error>

See: ZOOM_PROPERTY

pub fn set_zoom(&self, value: f32) -> Result<(), Error>

See: ZOOM_PROPERTY

pub fn get_zoom_minimum(&self) -> Result<f32, Error>

See: ZOOM_MINIMUM_PROPERTY

pub fn set_zoom_minimum(&self, value: f32) -> Result<(), Error>

See: ZOOM_MINIMUM_PROPERTY

pub fn get_zoom_maximum(&self) -> Result<f32, Error>

See: ZOOM_MAXIMUM_PROPERTY

pub fn set_zoom_maximum(&self, value: f32) -> Result<(), Error>

See: ZOOM_MAXIMUM_PROPERTY

pub fn get_step_multiplier(&self) -> Result<f32, Error>

See: STEP_MULTIPLIER_PROPERTY

pub fn set_step_multiplier(&self, value: f32) -> Result<(), Error>

See: STEP_MULTIPLIER_PROPERTY

pub fn get_allowed_scroll_axis(&self) -> Result<AllowedScrollAxis, Error>

See: ALLOWED_SCROLL_AXIS_PROPERTY

pub fn set_allowed_scroll_axis( &self, value: AllowedScrollAxis, ) -> Result<(), Error>

See: ALLOWED_SCROLL_AXIS_PROPERTY

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

See: REVERSED_X_AXIS_SCROLL_PROPERTY

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

See: REVERSED_X_AXIS_SCROLL_PROPERTY

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

See: REVERSED_Y_AXIS_SCROLL_PROPERTY

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

See: REVERSED_Y_AXIS_SCROLL_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 ScrollViewConcept

fn clone(&self) -> ScrollViewConcept

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollViewConcept

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

Formats the value using the given formatter.

impl Deref for ScrollViewConcept

type Target = Object

The resulting type after dereferencing.

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

Dereferences the value.

impl Inheritable for ScrollViewConcept

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 ScrollViewConcept

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<ScrollViewConcept> for ScrollView2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<ScrollViewConcept> for ScrollView3D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for ScrollViewConcept

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for ScrollViewConcept

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 ScrollViewConcept

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 ScrollViewConcept

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 ScrollViewConcept