iui 0.3.0

Simple, small, easy to distribute GUI bindings.
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

//! Available user interface controls and related functionality.
//! 
//! Note that `Control` and all specific control types are references to memory which is owned by the UI library.

use ui::UI;
use ui_sys::{self, uiControl};

use std::ptr;

#[macro_use]
mod create_macro;
mod basic;
pub use self::basic::*;
mod window;
pub use self::window::*;
mod layout;
pub use self::layout::*;
mod entry;
pub use self::entry::*;

/// A generic UI control. Any UI control can be turned into this type.
/// 
/// Note that `Control` and all specific control types are references
/// whose memory is owned by the UI library.
pub struct Control {
    ui_control: *mut uiControl,
}

impl Drop for Control {
    fn drop(&mut self) {
        // For now this does nothing, but in the future, when `libui` supports proper memory
        // management, this will likely need to twiddle reference counts.
    }
}

impl Clone for Control {
    fn clone(&self) -> Control {
        Control {
            ui_control: self.ui_control,
        }
    }
}

impl Control {
    /// Creates a new `Control` object from an existing `*mut uiControl`.
    pub unsafe fn from_ui_control(ui_control: *mut uiControl) -> Control {
        Control {
            ui_control: ui_control,
        }
    }

    /// Returns the underlying `*mut uiControl`.
    pub fn as_ui_control(&self) -> *mut uiControl {
        self.ui_control
    }

    /// Destroys a control. Any use of the control after this is use-after-free; therefore, this
    /// is marked unsafe.
    pub unsafe fn destroy(&self) {
        // Don't check for initialization here since this can be run during deinitialization.
        ui_sys::uiControlDestroy(self.ui_control)
    }
}

impl UI {
    // Return the parent control of the given control, or None if the control is orphaned.
    pub fn parent_of<T: Into<Control>>(&self, control: T) -> Option<Control> {
        unsafe {
            let ptr = ui_sys::uiControlParent(control.into().ui_control);
            if ptr.is_null() {
                None
            } else {
                Some(Control::from_ui_control(ptr))
            }
        }
    }

    /// Set the parent control of this control, "moving" it to a new place in
    /// the UI tree or, if passed `None`, removing it from the tree.
    // TODO: Does this actually need to be unsafe? I don't really see why it is.
    pub unsafe fn set_parent_of<T: Into<Control>>(&mut self, control: T, parent: Option<T>) {
        ui_sys::uiControlSetParent(
            control.into().ui_control,
            match parent {
                None => ptr::null_mut(),
                Some(parent) => parent.into().ui_control,
            },
        )
    }

    /// Returns true if this control is a top-level control; the root of
    /// the UI tree.
    pub fn is_toplevel<T: Into<Control>>(&self, control: T) -> bool {
        unsafe { ui_sys::uiControlToplevel(control.into().ui_control) != 0 }
    }

    /// Returns true if this control is currently set to be displayed.
    pub fn is_shown<T: Into<Control>>(&self, control: T) -> bool {
        unsafe { ui_sys::uiControlVisible(control.into().ui_control) != 0 }
    }

    /// Sets whether or not the control should be displayed.
    pub fn set_shown<T: Into<Control>>(&mut self, control: T, show: bool) {
        if show {
            unsafe { ui_sys::uiControlShow(control.into().ui_control) }
        } else {
            unsafe { ui_sys::uiControlHide(control.into().ui_control) }
        }
    }

    /// Returns true if the control is enabled (can be interacted with).
    pub fn is_enabled<T: Into<Control>>(&self, control: T) -> bool {
        unsafe { ui_sys::uiControlEnabled(control.into().ui_control) != 0 }
    }

    /// Sets the enable/disable state of the control. If disabled, a control
    /// cannot be interacted with, and visual cues to that effect are presented
    /// to the user.
    pub fn set_enabled<T: Into<Control>>(&mut self, control: T, enabled: bool) {
        if enabled {
            unsafe { ui_sys::uiControlEnable(control.into().ui_control) }
        } else {
            unsafe { ui_sys::uiControlDisable(control.into().ui_control) }
        }
    }
}