Trait components::KineticScrollViewExt[][src]

pub trait KineticScrollViewExt: 'static {
Show methods fn ensure_visible(&self, geometry: &Geometry);
fn get_acceleration_factor(&self) -> f64;
fn get_clamp_duration(&self) -> u32;
fn get_clamp_mode(&self) -> u64;
fn get_clamp_to_center(&self) -> bool;
fn get_deceleration(&self) -> f64;
fn get_input(&self) -> (Option<InputDevice>, Option<EventSequence>);
fn get_mouse_button(&self) -> u32;
fn get_overshoot(&self) -> f64;
fn get_scroll_policy(&self) -> ScrollPolicy;
fn get_snap_on_page(&self) -> bool;
fn get_use_captured(&self) -> bool;
fn get_use_grab(&self) -> bool;
fn set_acceleration_factor(&self, acceleration_factor: f64);
fn set_clamp_duration(&self, clamp_duration: u32);
fn set_clamp_mode(&self, clamp_mode: u64);
fn set_clamp_to_center(&self, clamp_to_center: bool);
fn set_deceleration(&self, rate: f64);
fn set_mouse_button(&self, button: u32);
fn set_overshoot(&self, overshoot: f64);
fn set_scroll_policy(&self, policy: ScrollPolicy);
fn set_snap_on_page(&self, snap_on_page: bool);
fn set_use_captured(&self, use_captured: bool);
fn set_use_grab(&self, use_grab: bool);
fn stop(&self);
fn get_property_snap_on_page(&self) -> bool;
fn set_property_snap_on_page(&self, snap_on_page: bool);
fn get_property_state(&self) -> KineticScrollViewState;
fn get_property_use_grab(&self) -> bool;
fn set_property_use_grab(&self, use_grab: bool);
fn connect_property_acceleration_factor_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_clamp_duration_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_clamp_mode_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_clamp_to_center_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_deceleration_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_mouse_button_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_overshoot_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_scroll_policy_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_snap_on_page_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_state_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_use_captured_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
fn connect_property_use_grab_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
}

Required methods

fn ensure_visible(&self, geometry: &Geometry)[src]

ensure_visible: @scroll: A #KineticScrollView @geometry: The region to make visible

Ensures that a given region is visible in the ScrollView, with the top-left taking precedence.

fn get_acceleration_factor(&self) -> f64[src]

get_acceleration_factor: @scroll: A #KineticScrollView

Retrieves the initial acceleration factor of the kinetic scroll-view.

Returns: The initial acceleration factor of the kinetic scroll-view

fn get_clamp_duration(&self) -> u32[src]

get_clamp_duration: @scroll: A #KineticScrollView

Retrieves the duration of the adjustment clamp animation.

Returns: Clamp duration

fn get_clamp_mode(&self) -> u64[src]

get_clamp_mode: @scroll: A #KineticScrollView

Retrieves the animation mode to use for the adjustment clamp animation.

Returns: Clamp mode

fn get_clamp_to_center(&self) -> bool[src]

get_clamp_to_center: @scroll: A #KineticScrollView

Retrieves whether to clamp to step increments based on the center of the page.

Returns: Clamp to center

fn get_deceleration(&self) -> f64[src]

get_deceleration: @scroll: A #KineticScrollView

Retrieves the deceleration rate of the kinetic scroll-view.

Returns: The deceleration rate of the kinetic scroll-view

fn get_input(&self) -> (Option<InputDevice>, Option<EventSequence>)[src]

get_input: @scroll: A #KineticScrollView @device: (allow-none) (out) (transfer none): a pointer to a #InputDevice pointer @sequence: (allow-none) (out) (transfer none): a pointer to a #EventSequence pointer

Retrieves informations about the current input device driving the scrolling.

fn get_mouse_button(&self) -> u32[src]

get_mouse_button: @scroll: A #KineticScrollView

Gets the #KineticScrollView:mouse-button property

Returns: The mouse button number used to initiate drag events on the kinetic scroll-view

fn get_overshoot(&self) -> f64[src]

get_overshoot: @scroll: A #KineticScrollView

Retrieves the deceleration rate multiplier used when the scroll-view is scrolling beyond its boundaries.

fn get_scroll_policy(&self) -> ScrollPolicy[src]

get_scroll_policy: @scroll: A #KineticScrollView

Retrieves the scrolling policy of the kinetic scroll-view.

fn get_snap_on_page(&self) -> bool[src]

get_snap_on_page: @scroll: A #KineticScrollView

Retrieves whether animations end on step increments.

Returns: #true if animations end on step increments, #false otherwise.

fn get_use_captured(&self) -> bool[src]

get_use_captured: @scroll: A #KineticScrollView

Gets the #KineticScrollView:use-captured property.

Returns: %true if captured-events should be used to initiate scrolling

fn get_use_grab(&self) -> bool[src]

get_use_grab: @scroll: A #KineticScrollView

Gets the #KineticScrollView:use-grab property.

Returns: %true if grab-events should be used to initiate scrolling

fn set_acceleration_factor(&self, acceleration_factor: f64)[src]

set_acceleration_factor: @scroll: A #KineticScrollView @acceleration_factor: The acceleration factor

Factor applied to the initial momentum.

fn set_clamp_duration(&self, clamp_duration: u32)[src]

set_clamp_duration: @scroll: A #KineticScrollView @clamp_duration: Clamp duration

Duration of the adjustment clamp animation.

fn set_clamp_mode(&self, clamp_mode: u64)[src]

set_clamp_mode: @scroll: A #KineticScrollView @clamp_mode: Clamp mode

Animation mode to use for the adjustment clamp animation.

fn set_clamp_to_center(&self, clamp_to_center: bool)[src]

set_clamp_to_center: @scroll: A #KineticScrollView @clamp_to_center: Clamp to center

Set whether to clamp to step increments based on the center of the page.

fn set_deceleration(&self, rate: f64)[src]

set_deceleration: @scroll: A #KineticScrollView @rate: The deceleration rate

Sets the deceleration rate when a drag is finished on the kinetic scroll-view. This is the value that the momentum is divided by every 60th of a second.

fn set_mouse_button(&self, button: u32)[src]

set_mouse_button: @scroll: A #KineticScrollView @button: A mouse button number

Sets the mouse button number used to initiate drag events on the kinetic scroll-view.

fn set_overshoot(&self, overshoot: f64)[src]

set_overshoot: @scroll: A #KineticScrollView @overshoot: The rate at which the view will decelerate when scrolling beyond its boundaries.

Sets the rate at which the view will decelerate when scrolling beyond its boundaries. The deceleration rate will be multiplied by this value every 60th of a second when the view is scrolling outside of the range set by its adjustments.

See set_deceleration()

fn set_scroll_policy(&self, policy: ScrollPolicy)[src]

set_scroll_policy: @scroll: A #KineticScrollView @policy: A #ScrollPolicy

Sets the scrolling policy for the kinetic scroll-view. This controls the possible axes of movement, and can affect the minimum size of the widget.

fn set_snap_on_page(&self, snap_on_page: bool)[src]

set_snap_on_page: @scroll: A #KineticScrollView @snap_on_page: #true to stop animations on step increments

Set whether to stop animations on step increments.

fn set_use_captured(&self, use_captured: bool)[src]

set_use_captured: @scroll: A #KineticScrollView @use_captured: %true to use captured events

Sets whether to use captured events to initiate drag events. This can be used to block events that would initiate scrolling from reaching the child actor.

fn set_use_grab(&self, use_grab: bool)[src]

set_use_grab: @scroll: A #KineticScrollView @use_grab: %true to use grab events

Sets whether to use grab events to initiate drag events. This can be used to block events that would initiate scrolling from reaching the child actor.

fn stop(&self)[src]

stop: @scroll: A #KineticScrollView

Stops any current movement due to kinetic scrolling.

fn get_property_snap_on_page(&self) -> bool[src]

fn set_property_snap_on_page(&self, snap_on_page: bool)[src]

fn get_property_state(&self) -> KineticScrollViewState[src]

fn get_property_use_grab(&self) -> bool[src]

fn set_property_use_grab(&self, use_grab: bool)[src]

fn connect_property_acceleration_factor_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_clamp_duration_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_clamp_mode_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_clamp_to_center_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_deceleration_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_mouse_button_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_overshoot_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_scroll_policy_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_snap_on_page_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_state_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_use_captured_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

fn connect_property_use_grab_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

Loading content...

Implementors

impl<O: Is<KineticScrollView>> KineticScrollViewExt for O[src]

fn ensure_visible(&self, geometry: &Geometry)[src]

ensure_visible: @scroll: A #KineticScrollView @geometry: The region to make visible

Ensures that a given region is visible in the ScrollView, with the top-left taking precedence.

fn get_acceleration_factor(&self) -> f64[src]

get_acceleration_factor: @scroll: A #KineticScrollView

Retrieves the initial acceleration factor of the kinetic scroll-view.

Returns: The initial acceleration factor of the kinetic scroll-view

fn get_clamp_duration(&self) -> u32[src]

get_clamp_duration: @scroll: A #KineticScrollView

Retrieves the duration of the adjustment clamp animation.

Returns: Clamp duration

fn get_clamp_mode(&self) -> u64[src]

get_clamp_mode: @scroll: A #KineticScrollView

Retrieves the animation mode to use for the adjustment clamp animation.

Returns: Clamp mode

fn get_clamp_to_center(&self) -> bool[src]

get_clamp_to_center: @scroll: A #KineticScrollView

Retrieves whether to clamp to step increments based on the center of the page.

Returns: Clamp to center

fn get_deceleration(&self) -> f64[src]

get_deceleration: @scroll: A #KineticScrollView

Retrieves the deceleration rate of the kinetic scroll-view.

Returns: The deceleration rate of the kinetic scroll-view

fn get_input(&self) -> (Option<InputDevice>, Option<EventSequence>)[src]

get_input: @scroll: A #KineticScrollView @device: (allow-none) (out) (transfer none): a pointer to a #InputDevice pointer @sequence: (allow-none) (out) (transfer none): a pointer to a #EventSequence pointer

Retrieves informations about the current input device driving the scrolling.

fn get_mouse_button(&self) -> u32[src]

get_mouse_button: @scroll: A #KineticScrollView

Gets the #KineticScrollView:mouse-button property

Returns: The mouse button number used to initiate drag events on the kinetic scroll-view

fn get_overshoot(&self) -> f64[src]

get_overshoot: @scroll: A #KineticScrollView

Retrieves the deceleration rate multiplier used when the scroll-view is scrolling beyond its boundaries.

fn get_scroll_policy(&self) -> ScrollPolicy[src]

get_scroll_policy: @scroll: A #KineticScrollView

Retrieves the scrolling policy of the kinetic scroll-view.

fn get_snap_on_page(&self) -> bool[src]

get_snap_on_page: @scroll: A #KineticScrollView

Retrieves whether animations end on step increments.

Returns: #true if animations end on step increments, #false otherwise.

fn get_use_captured(&self) -> bool[src]

get_use_captured: @scroll: A #KineticScrollView

Gets the #KineticScrollView:use-captured property.

Returns: %true if captured-events should be used to initiate scrolling

fn get_use_grab(&self) -> bool[src]

get_use_grab: @scroll: A #KineticScrollView

Gets the #KineticScrollView:use-grab property.

Returns: %true if grab-events should be used to initiate scrolling

fn set_acceleration_factor(&self, acceleration_factor: f64)[src]

set_acceleration_factor: @scroll: A #KineticScrollView @acceleration_factor: The acceleration factor

Factor applied to the initial momentum.

fn set_clamp_duration(&self, clamp_duration: u32)[src]

set_clamp_duration: @scroll: A #KineticScrollView @clamp_duration: Clamp duration

Duration of the adjustment clamp animation.

fn set_clamp_mode(&self, clamp_mode: u64)[src]

set_clamp_mode: @scroll: A #KineticScrollView @clamp_mode: Clamp mode

Animation mode to use for the adjustment clamp animation.

fn set_clamp_to_center(&self, clamp_to_center: bool)[src]

set_clamp_to_center: @scroll: A #KineticScrollView @clamp_to_center: Clamp to center

Set whether to clamp to step increments based on the center of the page.

fn set_deceleration(&self, rate: f64)[src]

set_deceleration: @scroll: A #KineticScrollView @rate: The deceleration rate

Sets the deceleration rate when a drag is finished on the kinetic scroll-view. This is the value that the momentum is divided by every 60th of a second.

fn set_mouse_button(&self, button: u32)[src]

set_mouse_button: @scroll: A #KineticScrollView @button: A mouse button number

Sets the mouse button number used to initiate drag events on the kinetic scroll-view.

fn set_overshoot(&self, overshoot: f64)[src]

set_overshoot: @scroll: A #KineticScrollView @overshoot: The rate at which the view will decelerate when scrolling beyond its boundaries.

Sets the rate at which the view will decelerate when scrolling beyond its boundaries. The deceleration rate will be multiplied by this value every 60th of a second when the view is scrolling outside of the range set by its adjustments.

See set_deceleration()

fn set_scroll_policy(&self, policy: ScrollPolicy)[src]

set_scroll_policy: @scroll: A #KineticScrollView @policy: A #ScrollPolicy

Sets the scrolling policy for the kinetic scroll-view. This controls the possible axes of movement, and can affect the minimum size of the widget.

fn set_snap_on_page(&self, snap_on_page: bool)[src]

set_snap_on_page: @scroll: A #KineticScrollView @snap_on_page: #true to stop animations on step increments

Set whether to stop animations on step increments.

fn set_use_captured(&self, use_captured: bool)[src]

set_use_captured: @scroll: A #KineticScrollView @use_captured: %true to use captured events

Sets whether to use captured events to initiate drag events. This can be used to block events that would initiate scrolling from reaching the child actor.

fn set_use_grab(&self, use_grab: bool)[src]

set_use_grab: @scroll: A #KineticScrollView @use_grab: %true to use grab events

Sets whether to use grab events to initiate drag events. This can be used to block events that would initiate scrolling from reaching the child actor.

fn stop(&self)[src]

stop: @scroll: A #KineticScrollView

Stops any current movement due to kinetic scrolling.

Loading content...