Struct gtk4::ScrolledWindow

source ·

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

Expand description

ScrolledWindow is a container that makes its child scrollable.

It does so 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. set_child() intelligently accounts for whether or not the added child is a Scrollable. If it isn’t, then it wraps the child in a Viewport. Therefore, you can just add any child widget and not worry about the details.

If set_child() 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:

⚠️ The following code is in c ⚠️

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

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

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

Unless property::ScrolledWindow::hscrollbar-policy and property::ScrolledWindow::vscrollbar-policy are PolicyType::Never or PolicyType::External, ScrolledWindow adds internal Scrollbar widgets around its child. The scroll position of the child, and if applicable the scrollbars, is controlled by the property::ScrolledWindow::hadjustment and property::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 property::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 signal::ScrolledWindow::edge-overshot signal.

If no mouse device is present, the scrollbars will overlaid 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 property::ScrolledWindow::overlay-scrolling property.

CSS nodes

ScrolledWindow has a main CSS node with name scrolledwindow. It gets a .frame style class added when property::ScrolledWindow::has-frame is true.

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.

Accessibility

ScrolledWindow uses the AccessibleRole::Group role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Struct gtk4::ScrolledWindow

Implementations§

impl ScrolledWindow

pub fn new() -> ScrolledWindow

pub fn builder() -> ScrolledWindowBuilder

pub fn child(&self) -> Option<Widget>

pub fn hadjustment(&self) -> Adjustment

pub fn has_frame(&self) -> bool

pub fn hscrollbar(&self) -> Widget

pub fn is_kinetic_scrolling(&self) -> bool

pub fn max_content_height(&self) -> i32

pub fn max_content_width(&self) -> i32

pub fn min_content_height(&self) -> i32

pub fn min_content_width(&self) -> i32

pub fn is_overlay_scrolling(&self) -> bool

pub fn placement(&self) -> CornerType

pub fn policy(&self) -> (PolicyType, PolicyType)

pub fn propagates_natural_height(&self) -> bool

pub fn propagates_natural_width(&self) -> bool

pub fn vadjustment(&self) -> Adjustment

pub fn vscrollbar(&self) -> Widget

pub fn set_child(&self, child: Option<&impl IsA<Widget>>)

pub fn set_hadjustment(&self, hadjustment: Option<&impl IsA<Adjustment>>)

pub fn set_has_frame(&self, has_frame: bool)

pub fn set_kinetic_scrolling(&self, kinetic_scrolling: bool)

pub fn set_max_content_height(&self, height: i32)

pub fn set_max_content_width(&self, width: i32)

pub fn set_min_content_height(&self, height: i32)

pub fn set_min_content_width(&self, width: i32)

pub fn set_overlay_scrolling(&self, overlay_scrolling: bool)

pub fn set_placement(&self, window_placement: CornerType)

pub fn set_policy( &self, hscrollbar_policy: PolicyType, vscrollbar_policy: PolicyType )

pub fn set_propagate_natural_height(&self, propagate: bool)

pub fn set_propagate_natural_width(&self, propagate: bool)

pub fn set_vadjustment(&self, vadjustment: Option<&impl IsA<Adjustment>>)

pub fn unset_placement(&self)

pub fn hscrollbar_policy(&self) -> PolicyType

pub fn set_hscrollbar_policy(&self, hscrollbar_policy: PolicyType)

pub fn vscrollbar_policy(&self) -> PolicyType

pub fn set_vscrollbar_policy(&self, vscrollbar_policy: PolicyType)

pub fn window_placement(&self) -> CornerType

pub fn set_window_placement(&self, window_placement: CornerType)

pub fn connect_edge_overshot<F: Fn(&Self, PositionType) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_edge_reached<F: Fn(&Self, PositionType) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_move_focus_out<F: Fn(&Self, DirectionType) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn emit_move_focus_out(&self, direction_type: DirectionType)

pub fn connect_scroll_child<F: Fn(&Self, ScrollType, bool) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

pub fn emit_scroll_child(&self, scroll: ScrollType, horizontal: bool) -> bool

pub fn connect_child_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_hadjustment_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_has_frame_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_hscrollbar_policy_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_kinetic_scrolling_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_max_content_height_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_max_content_width_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_min_content_height_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_min_content_width_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_overlay_scrolling_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_propagate_natural_height_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_propagate_natural_width_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_vadjustment_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_vscrollbar_policy_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_window_placement_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations§

impl Clone for ScrolledWindow

fn clone(&self) -> Self

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

impl Debug for ScrolledWindow

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

impl Default for ScrolledWindow

fn default() -> Self

impl Display for ScrolledWindow

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

impl Hash for ScrolledWindow

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

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

impl Ord for ScrolledWindow

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

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

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