Struct native_windows_gui::ScrollBar

pub struct ScrollBar {
    pub handle: ControlHandle,
    /* private fields */
}

A window can display a data object, such as a document or a bitmap, that is larger than the window’s client area. When provided with a scroll bar, the user can scroll a data object in the client area to bring into view the portions of the object that extend beyond the borders of the window.

Requires the scroll-bar feature.

Builder parameters:

• parent: Required. The scroll bar parent container.
• size: The scroll bar size.
• position: The scroll bar position.
• focus: The control receive focus after being created
• flags: A combination of the ScrollBarFlags values.
• ex_flags: A combination of win32 window extended flags. Unlike flags, ex_flags must be used straight from winapi
• range: The value range of the scroll bar
• pos: he current value of the scroll bar

Control events:

• OnVerticalScroll: When the value of a scrollbar with the VERTICAL flags is changed
• OnHorizontalScroll: When the value of a scrollbar with the HORIZONTAL flags is changed
• MousePress(_): Generic mouse press events on the button
• OnMouseMove: Generic mouse event
• OnMouseWheel: Generic mouse wheel event

use native_windows_gui as nwg;

fn build_scrollbar(button: &mut nwg::ScrollBar, window: &nwg::Window) {
    nwg::ScrollBar::builder()
        .range(Some(0..100))
        .pos(Some(10))
        .parent(window)
        .build(button);
}

Fields

handle: ControlHandle

Implementations

impl ScrollBar

pub fn builder<'a>() -> ScrollBarBuilder

pub fn pos(&self) -> usize

Retrieves the current logical position of the slider in a scrollbar. The logical positions are the integer values in the scrollbar’s range of minimum to maximum slider positions.

pub fn set_pos(&self, p: usize)

Sets the current logical position of the slider in a scrollbar. If the value is out of range he value is rounded up or down to the nearest valid value..

pub fn range(&self) -> Range<usize>

Returns the range of value the scrollbar can have

pub fn set_range(&self, range: Range<usize>)

Sets the range of value the scrollbar can have

pub fn focus(&self) -> bool

Returns true if the control currently has the keyboard focus

pub fn set_focus(&self)

Sets the keyboard focus on the button.

pub fn enabled(&self) -> bool

Returns true if the control user can interact with the control, return false otherwise

pub fn set_enabled(&self, v: bool)

Enable or disable the control

pub fn visible(&self) -> bool

Returns true if the control is visible to the user. Will return true even if the control is outside of the parent client view (ex: at the position (10000, 10000))

pub fn set_visible(&self, v: bool)

Show or hide the control to the user

pub fn size(&self) -> (u32, u32)

Returns the size of the button in the parent window

pub fn set_size(&self, x: u32, y: u32)

Sets the size of the button in the parent window

pub fn position(&self) -> (i32, i32)

Returns the position of the button in the parent window

pub fn set_position(&self, x: i32, y: i32)

Sets the position of the button in the parent window

pub fn class_name(&self) -> &'static str

Winapi class name used during control creation

pub fn flags(&self) -> u32

Winapi base flags used during window creation

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations

impl Default for ScrollBar

fn default() -> ScrollBar

Returns the “default value” for a type.

impl Drop for ScrollBar

fn drop(&mut self)

Executes the destructor for this type.

impl From<&ScrollBar> for ControlHandle

fn from(control: &ScrollBar) -> Self

Converts to this type from the input type.

impl From<&mut ScrollBar> for ControlHandle

fn from(control: &mut ScrollBar) -> Self

Converts to this type from the input type.

impl PartialEq<ControlHandle> for ScrollBar

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ScrollBar> for ControlHandle

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ScrollBar> for ScrollBar

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.