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
/*!
    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;

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

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

pub use controls::window::{WindowT, Window};
pub use controls::menu::{MenuT, Menu, MenuItemT, MenuItem};
use ui::Ui;
use events::Event;
use error::Error;

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

/**
    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;

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

}