Struct native_windows_gui::ScrollBar [−][src]
pub struct ScrollBar { pub handle: ControlHandle, // some fields omitted }
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 createdflags
: A combination of the ScrollBarFlags values.ex_flags
: A combination of win32 window extended flags. Unlikeflags
, ex_flags must be used straight from winapirange
: The value range of the scroll barpos
: he current value of the scroll bar
Control events:
OnVerticalScroll
: When the value of a scrollbar with the VERTICAL flags is changedOnHorizontalScroll
: When the value of a scrollbar with the HORIZONTAL flags is changedMousePress(_)
: Generic mouse press events on the buttonOnMouseMove
: Generic mouse eventOnMouseWheel
: 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
[src]
pub fn builder<'a>() -> ScrollBarBuilder
[src]
pub fn pos(&self) -> usize
[src]
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)
[src]
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>
[src]
Returns the range of value the scrollbar can have
pub fn set_range(&self, range: Range<usize>)
[src]
Sets the range of value the scrollbar can have
pub fn focus(&self) -> bool
[src]
Returns true if the control currently has the keyboard focus
pub fn set_focus(&self)
[src]
Sets the keyboard focus on the button.
pub fn enabled(&self) -> bool
[src]
Returns true if the control user can interact with the control, return false otherwise
pub fn set_enabled(&self, v: bool)
[src]
Enable or disable the control
pub fn visible(&self) -> bool
[src]
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)
[src]
Show or hide the control to the user
pub fn size(&self) -> (u32, u32)
[src]
Returns the size of the button in the parent window
pub fn set_size(&self, x: u32, y: u32)
[src]
Sets the size of the button in the parent window
pub fn position(&self) -> (i32, i32)
[src]
Returns the position of the button in the parent window
pub fn set_position(&self, x: i32, y: i32)
[src]
Sets the position of the button in the parent window
pub fn class_name(&self) -> &'static str
[src]
Winapi class name used during control creation
pub fn flags(&self) -> u32
[src]
Winapi base flags used during window creation
pub fn forced_flags(&self) -> u32
[src]
Winapi flags required by the control
Trait Implementations
impl Default for ScrollBar
[src]
impl Drop for ScrollBar
[src]
impl From<&'_ ScrollBar> for ControlHandle
[src]
impl From<&'_ mut ScrollBar> for ControlHandle
[src]
impl PartialEq<ControlHandle> for ScrollBar
[src]
fn eq(&self, other: &ControlHandle) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialEq<ScrollBar> for ScrollBar
[src]
impl PartialEq<ScrollBar> for ControlHandle
[src]
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 T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,