newt 0.7.2

Rust bindings for the Newt console UI library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//
// Copyright (C) 2019,2025 Robert Gill <rtgill82@gmail.com>
//
// This file is a part of newt-rs.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License version 2.1 as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

use std::cell::Cell;

use newt_sys::*;
use crate::component::Component;
use crate::private::funcs::*;

///
/// A vertical scrollbar which can be attached to a
/// [Form](crate::widgets::form::Form).
///
#[derive(Component)]
pub struct VerticalScrollbar {
    co: Cell<newtComponent>,
    added_to_parent: Cell<bool>
}

impl VerticalScrollbar {
    ///
    /// Create a new `VerticalScrollbar`.
    ///
    /// * `left` - The left-most position of the `VerticalScrollbar`.
    /// * `top` - The top-most position of the `VerticalScrollabar`.
    /// * `height` - The height of the `VerticalScrollbar`.
    /// * `normal_colorset` - The normal color set of the `VerticalScrollbar`.
    /// * `thumb_colorset` - The color set when the thumb button is activated.
    ///
    /// (as of `newt-0.52.25`, `thumb_colorset` does not appear to be used)
    ///
    pub fn new(left: i32, top: i32, height: i32, normal_colorset: i32,
               thumb_colorset: i32) -> VerticalScrollbar
    {
        unsafe {
            let co = newtVerticalScrollbar(
                left,
                top,
                height,
                normal_colorset,
                thumb_colorset
            );

            if co.is_null() {
                malloc_failure();
            }

            VerticalScrollbar {
                co: Cell::new(co),
                added_to_parent: Cell::new(false)
            }
        }
    }

    ///
    /// Set the current scroll position of the `VerticalScrollbar`.
    ///
    /// * `where` - The new scroll position of the `VerticalScrollbar`.
    /// * `total` - The amount of the range of the `VerticalScrollbar` used
    ///   to calculate the new position. `0` or `1` means to use the entirety
    ///   of the range.
    ///
    pub fn set(&self, where_: i32, total: i32) {
        unsafe {
            newtScrollbarSet(self.co(), where_, total);
        }
    }

    ///
    /// Set the colors of the `VerticalScrollbar`.
    ///
    /// * `normal` - The normal color set of the `VerticalScrollbar`.
    /// * `thumb` - The color set when the thumb button is activated.
    ///
    /// (as of `newt-0.52.25`, the `thumb` color set does not appear to be used)
    ///
    pub fn set_colors(&self, normal: i32, thumb: i32) {
        unsafe {
            newtScrollbarSetColors(self.co(), normal, thumb);
        }
    }
}