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

// Pushrod
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Pushrod is a Cross Platform UI Widget Library for Rust.
//!
//! It is intended to be lightweight, easy to use, and easy to understand.  Pushrod draws
//! inspiration from 16-bit GUI-based systems and other GUI libraries over the years.
//!
//! # Dependencies
//! Pushrod uses the following dependencies:
//! ```ignore
//! [dependencies]
//! piston_window = "^0.89.0"
//! find_folder = "^0.3.0"
//! ```
//!
//! To use the crate in your project, add the following dependencies:
//! ```ignore
//! [dependencies]
//! rust-pushrod = "^0.1"
//! ```
//!
//! # Core Components
//!
//! # Callbacks
//!
//! # Events
//!
//! # Widgets
//! The following `Widget` objects are provided:
//!
//! `BaseWidget` is a top-level `Widget` object.  It can be configured with
//! an origin, size, and background color.  If you wish to design your own `Widget`, you would
//! want to either extend the `BaseWidget`, or use it as a backing in your own `Widget` object.
//! (See `BoxWidget` for an example of how to use it in tandem with another object.)
//!
//! `BoxWidget` incorporates a `BaseWidget`, extending it to include a border color and width.
//!
//! `TextWidget` provides a way to display text in the main window.  Fonts are in `ttf` format,
//! which can be downloaded from Google, so long as they are free/open source.  One has been
//! included with the source distribution in the `assets` directory.
//!
//! `TimerWidget` provides a rudimentary timer, which increases ticks based on the screen
//! refresh.  After a timer has expired, a callback is triggered, allowing an action to occur.
//!
//! `ImageWidget` draws an image on the screen.  `png` format has been tested, but `jpg` and `gif`
//! formats should also work, as they are part of the Piston library.

/// Main module containing the run loop for the UI components, containers for windows and
/// `Widget` trait objects, and so on.  Contains the core elements required to build
/// a UI.
pub mod core;

/// Companion module used to define and trigger system-wide events.  Uses an event masking
/// style similar to the Atari ST GEM series: event masks can be used to tell the Pushrod
/// run loop which events the programmer desires to receive.
pub mod event;

/// Widget library used for on-screen UI interaction.  This is a core set of `Widget`
/// objects that are used to allow users to interact with an application.  Contains a core set
/// of widgets that can be extended.
///
/// Currently contains:
/// - Base Widget (for drawing a plain background)
/// - Box Widget (for drawing a plain background with a box and a colored border)
/// - Text Widget (for drawing text)
/// - Timer Widget (for performing timer operations)
/// - Image Widget (for drawing images)
pub mod widget;