Struct ScrollInfo

pub struct ScrollInfo { /* private fields */ }

Available on crate feature v4_12 only.

The ScrollInfo can be used to provide more accurate data on how a scroll operation should be performed.

Scrolling functions usually allow passing a None scroll info which will cause the default values to be used and just scroll the element into view.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl ScrollInfo

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

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GtkScrollInfo) -> &Self

Borrows the underlying C value.

impl ScrollInfo

pub fn new() -> ScrollInfo

Creates a new scroll info for scrolling an element into view.

Returns

A new scroll info

pub fn enables_horizontal(&self) -> bool

Checks if horizontal scrolling is enabled.

Returns

true if horizontal scrolling is enabled.

pub fn enables_vertical(&self) -> bool

Checks if vertical scrolling is enabled.

Returns

true if vertical scrolling is enabled.

pub fn set_enable_horizontal(&self, horizontal: bool)

Turns horizontal scrolling on or off.

horizontal

if scrolling in the horizontal direction should happen

pub fn set_enable_vertical(&self, vertical: bool)

Turns vertical scrolling on or off.

vertical

if scrolling in the vertical direction should happen

Trait Implementations

impl Clone for ScrollInfo

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for ScrollInfo

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

Formats the value using the given formatter.

impl Default for ScrollInfo

fn default() -> Self

Returns the “default value” for a type.

impl From<ScrollInfo> for Value

fn from(s: ScrollInfo) -> Self

Converts to this type from the input type.

impl HasParamSpec for ScrollInfo

type ParamSpec = ParamSpecBoxed

type SetValue = ScrollInfo

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, ScrollInfo>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ScrollInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ScrollInfo

fn cmp(&self, other: &ScrollInfo) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ScrollInfo

fn eq(&self, other: &ScrollInfo) -> 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 PartialOrd for ScrollInfo

fn partial_cmp(&self, other: &ScrollInfo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ScrollInfo

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ScrollInfo

impl StructuralPartialEq for ScrollInfo