[−]Struct gtk::ScrolledWindow

pub struct ScrolledWindow(_, _);

ScrolledWindow is a container that accepts a single child widget, makes that child scrollable using either internally added scrollbars or externally associated adjustments, and optionally draws a frame around the child.

Widgets with native scrolling support, i.e. those whose classes implement the Scrollable interface, are added directly. For other types of widget, the class Viewport acts as an adaptor, giving scrollability to other widgets. ScrolledWindow’s implementation of ContainerExt::add intelligently accounts for whether or not the added child is a Scrollable. If it isn’t, ScrolledWindow wraps the child in a Viewport and adds that for you. Therefore, you can just add any child widget and not worry about the details.

If ContainerExt::add has added a Viewport for you, you can remove both your added child widget from the Viewport, and the Viewport from the ScrolledWindow, like this:

GtkWidget *scrolled_window = gtk_scrolled_window_new (NULL, NULL);
GtkWidget *child_widget = gtk_button_new ();

// GtkButton is not a GtkScrollable, so GtkScrolledWindow will automatically
// add a GtkViewport.
gtk_container_add (GTK_CONTAINER (scrolled_window),
                   child_widget);

// Either of these will result in child_widget being unparented:
gtk_container_remove (GTK_CONTAINER (scrolled_window),
                      child_widget);
// or
gtk_container_remove (GTK_CONTAINER (scrolled_window),
                      gtk_bin_get_child (GTK_BIN (scrolled_window)));

Unless ScrolledWindow:policy is GTK_POLICY_NEVER or GTK_POLICY_EXTERNAL, ScrolledWindow adds internal Scrollbar widgets around its child. The scroll position of the child, and if applicable the scrollbars, is controlled by the ScrolledWindow:hadjustment and ScrolledWindow:vadjustment that are associated with the ScrolledWindow. See the docs on Scrollbar for the details, but note that the “step_increment” and “page_increment” fields are only effective if the policy causes scrollbars to be present.

If a ScrolledWindow doesn’t behave quite as you would like, or doesn’t have exactly the right layout, it’s very possible to set up your own scrolling with Scrollbar and for example a Grid.

Touch support

ScrolledWindow has built-in support for touch devices. When a touchscreen is used, swiping will move the scrolled window, and will expose 'kinetic' behavior. This can be turned off with the ScrolledWindow:kinetic-scrolling property if it is undesired.

ScrolledWindow also displays visual 'overshoot' indication when the content is pulled beyond the end, and this situation can be captured with the ScrolledWindow::edge-overshot signal.

If no mouse device is present, the scrollbars will overlayed as narrow, auto-hiding indicators over the content. If traditional scrollbars are desired although no mouse is present, this behaviour can be turned off with the ScrolledWindow:overlay-scrolling property.

CSS nodes

ScrolledWindow has a main CSS node with name scrolledwindow.

It uses subnodes with names overshoot and undershoot to draw the overflow and underflow indications. These nodes get the .left, .right, .top or .bottom style class added depending on where the indication is drawn.

ScrolledWindow also sets the positional style classes (.left, .right, .top, .bottom) and style classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering) on its scrollbars.

If both scrollbars are visible, the area where they meet is drawn with a subnode named junction.

Implements

ScrolledWindowExt, BinExt, ContainerExt, WidgetExt, glib::object::ObjectExt, BuildableExt, WidgetExtManual, BuildableExtManual

Implementations

`impl ScrolledWindow`[src]

`pub fn new<P: IsA<Adjustment>, Q: IsA<Adjustment>>( hadjustment: Option<&P>, vadjustment: Option<&Q> ) -> ScrolledWindow`[src]

Creates a new scrolled window.

The two arguments are the scrolled window’s adjustments; these will be shared with the scrollbars and the child widget to keep the bars in sync with the child. Usually you want to pass None for the adjustments, which will cause the scrolled window to create them for you.

`hadjustment`

horizontal adjustment

`vadjustment`

vertical adjustment

Returns

a new scrolled window

Trait Implementations

`impl Clone for ScrolledWindow`

`fn clone(&self) -> ScrolledWindow`

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for ScrolledWindow`

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

`impl Display for ScrolledWindow`[src]

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

`impl Eq for ScrolledWindow`

`impl Hash for ScrolledWindow`

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

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

`impl IsA<Bin> for ScrolledWindow`

`impl IsA<Buildable> for ScrolledWindow`

`impl IsA<Container> for ScrolledWindow`

`impl IsA<ScrolledWindow> for PlacesSidebar`

`impl IsA<Widget> for ScrolledWindow`

`impl Ord for ScrolledWindow`

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

`#[must_use]fn max(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn min(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl<T: ObjectType> PartialEq<T> for ScrolledWindow`

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

`#[must_use]fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl<T: ObjectType> PartialOrd<T> for ScrolledWindow`

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

`#[must_use]fn lt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn le(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn gt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn ge(&self, other: &Rhs) -> bool`1.0.0[src]

`impl StaticType for ScrolledWindow`

`fn static_type() -> Type`

Auto Trait Implementations

`impl RefUnwindSafe for ScrolledWindow`

`impl !Send for ScrolledWindow`

`impl !Sync for ScrolledWindow`

`impl Unpin for ScrolledWindow`

`impl UnwindSafe for ScrolledWindow`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<Super, Sub> CanDowncast for Super where Sub: IsA<Super>, Super: IsA<Super>,`

`impl<T> Cast for T where T: ObjectType,`

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

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

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

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

`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) -> T where T: ObjectType,`

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

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ObjectExt for T where T: ObjectType,`

`fn is(&self) -> bool where U: StaticType,`

`fn get_type(&self) -> Type`

`fn get_object_class(&self) -> &ObjectClass`

`fn set_properties( &self, property_values: &[(&str, &dyn ToValue)] ) -> Result<(), BoolError>`

`fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue ) -> Result<(), BoolError> where N: Into<&'a str>,`

`fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,`

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

`unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&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 get_data<QD>(&self, key: &str) -> Option<&QD> where QD: 'static,`

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

`fn block_signal(&self, handler_id: &SignalHandlerId)`

`fn unblock_signal(&self, handler_id: &SignalHandlerId)`

`fn stop_signal_emission(&self, signal_name: &str)`

`fn disconnect(&self, handler_id: SignalHandlerId)`

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

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

`fn notify<'a, N>(&self, property_name: N) where N: Into<&'a str>,`

`fn notify_by_pspec(&self, pspec: &ParamSpec)`

`fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where N: Into<&'a str>,`

`fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where N: Into<&'a str>,`

`fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where N: Into<&'a str>,`

`fn list_properties(&self) -> Vec<ParamSpec>`

`fn connect<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, N: Into<&'a str>,`

`fn connect_local<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + 'static, N: Into<&'a str>,`

`unsafe fn connect_unsafe<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value>, N: Into<&'a str>,`

`fn emit<'a, N>( &self, signal_name: N, args: &[&dyn ToValue] ) -> Result<Option<Value>, BoolError> where N: Into<&'a str>,`

`fn downgrade(&self) -> WeakRef<T>`

`fn bind_property<'a, O, N, M>( &'a self, source_property: N, target: &'a O, target_property: M ) -> BindingBuilder<'a> where M: Into<&'a str>, N: Into<&'a str>, O: ObjectType,`

`fn ref_count(&self) -> u32`

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`

`fn to_glib_full_from_slice(_t: &[T]) -> *const GList`

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`

`fn to_glib_full_from_slice(_t: &[T]) -> *const GPtrArray`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GArray`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GList`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GPtrArray`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T> ToValue for T where T: SetValue + ?Sized,`

`fn to_value(&self) -> Value`

`fn to_value_type(&self) -> Type`

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

[−]Struct gtk::ScrolledWindow

Touch support

CSS nodes

Implements

Implementations

impl ScrolledWindow[src]

pub fn new<P: IsA<Adjustment>, Q: IsA<Adjustment>>( hadjustment: Option<&P>, vadjustment: Option<&Q>) -> ScrolledWindow[src]

hadjustment

vadjustment

Returns

Trait Implementations

impl Clone for ScrolledWindow

fn clone(&self) -> ScrolledWindow

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for ScrolledWindow

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

impl Display for ScrolledWindow[src]

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

impl Eq for ScrolledWindow

impl Hash for ScrolledWindow

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

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

impl IsA<Bin> for ScrolledWindow

impl IsA<Buildable> for ScrolledWindow

impl IsA<Container> for ScrolledWindow

impl IsA<ScrolledWindow> for PlacesSidebar

impl IsA<Widget> for ScrolledWindow

impl Ord for ScrolledWindow

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

#[must_use]fn max(self, other: Self) -> Self1.21.0[src]

#[must_use]fn min(self, other: Self) -> Self1.21.0[src]

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[src]

impl<T: ObjectType> PartialEq<T> for ScrolledWindow

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

#[must_use]fn ne(&self, other: &Rhs) -> bool1.0.0[src]

impl<T: ObjectType> PartialOrd<T> for ScrolledWindow

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

#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn gt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn ge(&self, other: &Rhs) -> bool1.0.0[src]

impl StaticType for ScrolledWindow

fn static_type() -> Type

Auto Trait Implementations

impl RefUnwindSafe for ScrolledWindow

impl !Send for ScrolledWindow

impl !Sync for ScrolledWindow

impl Unpin for ScrolledWindow

impl UnwindSafe for ScrolledWindow