Struct gtk::Scrollbar

source · [−]

#[repr(transparent)]
pub struct Scrollbar { /* private fields */ }

Expand description

The Scrollbar widget is a horizontal or vertical scrollbar, depending on the value of the property::Orientable::orientation property.

Its position and movement are controlled by the adjustment that is passed to or created by new(). See Adjustment for more details. The property::Adjustment::value field sets the position of the thumb and must be between property::Adjustment::lower and property::Adjustment::upper - property::Adjustment::page-size. The property::Adjustment::page-size represents the size of the visible scrollable area. The fields property::Adjustment::step-increment and property::Adjustment::page-increment fields are added to or subtracted from the property::Adjustment::value when the user asks to move by a step (using e.g. the cursor arrow keys or, if present, the stepper buttons) or by a page (using e.g. the Page Down/Up keys).

CSS nodes

⚠️ The following code is in plain ⚠️

scrollbar[.fine-tune]
╰── contents
    ├── [button.up]
    ├── [button.down]
    ├── trough
    │   ╰── slider
    ├── [button.up]
    ╰── [button.down]

GtkScrollbar has a main CSS node with name scrollbar and a subnode for its contents, with subnodes named trough and slider.

The main node gets the style class .fine-tune added when the scrollbar is in ‘fine-tuning’ mode.

If steppers are enabled, they are represented by up to four additional subnodes with name button. These get the style classes .up and .down to indicate in which direction they are moving.

Other style classes that may be added to scrollbars inside ScrolledWindow include the positional classes (.left, .right, .top, .bottom) and style classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering).

Implements

RangeExt, WidgetExt, glib::ObjectExt, BuildableExt, OrientableExt, WidgetExtManual, BuildableExtManual

Struct gtk::Scrollbar

Implementations

impl Scrollbar

pub const NONE: Option<&'static Scrollbar> = None

pub fn new( orientation: Orientation, adjustment: Option<&impl IsA<Adjustment>>) -> Scrollbar

pub fn builder() -> ScrollbarBuilder

Trait Implementations

impl Clone for Scrollbar

fn clone(&self) -> Self

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

impl Debug for Scrollbar

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

impl Default for Scrollbar

fn default() -> Self

impl Display for Scrollbar

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

impl Hash for Scrollbar

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

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

impl Ord for Scrollbar

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

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

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

const fn clamp(self, min: Self, max: Self) -> Selfwhere Self: PartialOrd<Self>,

impl ParentClassIs for Scrollbar

type Parent = Range

impl<OT: ObjectType> PartialEq<OT> for Scrollbar

fn eq(&self, other: &OT) -> bool

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

impl<OT: ObjectType> PartialOrd<OT> for Scrollbar

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

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

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

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

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

impl StaticType for Scrollbar

fn static_type() -> Type

impl Eq for Scrollbar

impl IsA<Buildable> for Scrollbar

impl IsA<Orientable> for Scrollbar

impl IsA<Range> for Scrollbar

impl IsA<Widget> for Scrollbar

Auto Trait Implementations

impl RefUnwindSafe for Scrollbar

impl !Send for Scrollbar

impl !Sync for Scrollbar

impl Unpin for Scrollbar

impl UnwindSafe for Scrollbar

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Cast for Twhere T: ObjectType,

fn upcast<T>(self) -> Twhere T: ObjectType, Self: IsA<T>,

fn upcast_ref<T>(&self) -> &Twhere T: ObjectType, Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>where T: ObjectType, Self: CanDowncast<T>,

fn downcast_ref<T>(&self) -> Option<&T>where T: ObjectType, Self: CanDowncast<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> Twhere T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere T: ObjectType,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<U> IsSubclassableExt for Uwhere U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>)where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>)where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for Twhere T: ObjectType,

fn is<U>(&self) -> boolwhere U: StaticType,

fn type_(&self) -> Type

fn object_class(&self) -> &Class<Object>

fn class(&self) -> &Class<T>where T: IsClass,

fn class_of<U>(&self) -> Option<&Class<U>>where U: IsClass,

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where U: IsInterface,

fn set_property<V>(&self, property_name: &str, value: V)where V: ToValue,

fn set_property_from_value(&self, property_name: &str, value: &Value)

pub fn new(
orientation: Orientation,
adjustment: Option<&impl IsA<Adjustment>>
) -> Scrollbar

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

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

const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> Cast for Twhere
T: ObjectType,

fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,

fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: CanDowncast<T>,

fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: CanDowncast<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>)where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>)where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for Twhere
T: ObjectType,

fn is<U>(&self) -> boolwhere
U: StaticType,

fn class(&self) -> &Class<T>where
T: IsClass,

fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,

fn set_property<V>(&self, property_name: &str, value: V)where
V: ToValue,

fn property<V>(&self, property_name: &str) -> Vwhere
V: 'static + for<'b> FromValue<'b>,

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,

unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,

fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,

fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,

fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value>,

fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value>,

unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,

unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,

fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId

fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Option<Value>

fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Option<Value>

fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Option<Value>

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: 'static + Fn(&T, &ParamSpec),

unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec),

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>where
F: 'static + FnOnce() + Send,

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
F: 'static + FnOnce(),

fn bind_property<'f, 't, O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,

impl<T> StaticTypeExt for Twhere
T: StaticType,

impl<T> ToClosureReturnValue for Twhere
T: ToValue,

impl<T> ToOwned for Twhere
T: Clone,

impl<T> ToString for Twhere
T: Display + ?Sized,