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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*!
    Control trait definition. The base control definitions are located in the submodules.
*/
/*
    Copyright (C) 2016  Gabriel Dubé

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

pub mod window;
pub mod menu;
pub mod button;
pub mod textinput;
pub mod textbox;
pub mod checkbox;
pub mod radiobutton;
pub mod label;
pub mod listbox;
pub mod combobox;
pub mod groupbox;
pub mod progress_bar;
pub mod datepicker;
pub mod file_dialog;
pub mod timer;
pub mod canvas;

use std::any::TypeId;
use std::hash::Hash;

use winapi::{HWND, HMENU, UINT, HFONT};

pub use controls::window::{WindowT, Window};
pub use controls::menu::{MenuT, Menu, MenuItemT, MenuItem, SeparatorT, Separator};
pub use controls::button::{ButtonT, Button};
pub use controls::textinput::{TextInputT, TextInput};
pub use controls::textbox::{TextBoxT, TextBox};
pub use controls::checkbox::{CheckBoxT, CheckBox};
pub use controls::radiobutton::{RadioButtonT, RadioButton};
pub use controls::label::{LabelT, Label};
pub use controls::listbox::{ListBoxT, ListBox};
pub use controls::combobox::{ComboBoxT, ComboBox};
pub use controls::groupbox::{GroupBoxT, GroupBox};
pub use controls::progress_bar::{ProgressBarT, ProgressBar};
pub use controls::file_dialog::{FileDialogT, FileDialog};
pub use controls::timer::{TimerT, Timer};
pub use controls::canvas::{CanvasT, Canvas, CanvasRenderer};
pub use controls::datepicker::{DatePickerT, DatePicker};
use ui::Ui;
use events::Event;
use error::Error;

/**
    A type that expose the different underlying handle into one type
*/
#[derive(Clone, Hash, Debug)]
#[allow(non_camel_case_types)]
pub enum AnyHandle {
    HWND(HWND),
    HMENU(HMENU),
    HMENU_ITEM(HMENU, UINT),
    HFONT(HFONT),
    Custom(TypeId, usize)
}

/**
    An enum that list type names for the common controls.

    This is used internally to differentiate the common control notification codes.
*/
#[derive(Clone, Debug)]
pub enum ControlType {
    Window,
    Button,
    TextInput,
    TextBox,
    CheckBox,
    RadioButton,
    ListBox,
    Label,
    ProgressBar,
    Menu,
    MenuItem,
    Timer,
    ComboBox,
    GroupBox,
    NumericInput,
    DatePicker,
    FileDialog,
    Canvas,
    Undefined  // Control is not a common control
}

/**
    Structures implementing this trait can be used by a Ui to build a Control
*/
pub trait ControlT<ID: Clone+Hash> {

    /**
        Should return the TypeId of the generated control. For example a `WindowT` struct returns the TypeId of a `Window` struct.
    */
    fn type_id(&self) -> TypeId;

    /**
        Should instance the control and return it as a Box<Control>. If an error is raised, it will be returned by `ui.commit`.
    */
    fn build(&self, ui: &Ui<ID>) -> Result<Box<Control>, Error>;

    /**
        Should return the events supported by the control.
    */
    fn events(&self) -> Vec<Event> { Vec::new() }
}

/**
    Structures implementing this trait are controls that can be stored in a Ui
*/
pub trait Control {

    /**
        Should return the underlying handle to the object
    */
    fn handle(&self) -> AnyHandle;

    /**
        Should return the type of the control. For custom controls, the return value should be `Undefined` (the default).
    */
    fn control_type(&self) -> ControlType { ControlType::Undefined }

    /**
        If specified, should free any ressource allocated in the template `build` function. This includes functions like `DestroyWindow`.
    */
    fn free(&mut self) {}

}