Skip to content

Commit

Permalink
+ docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oktonion committed Jul 20, 2019
1 parent 45542b4 commit 162e25e
Show file tree
Hide file tree
Showing 11 changed files with 63 additions and 11 deletions.
7 changes: 6 additions & 1 deletion src/Button.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@

namespace PhWidgets
{

//! A button for initiating an action
/*!
The Button class draws a button.
Buttons let you initiate an action within your application;
clicking a button invokes an application callback.
*/
class Button:
public Label
{
Expand Down
7 changes: 6 additions & 1 deletion src/Compound.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@

namespace PhWidgets
{

//! Superclass for all compound widgets
/*!
The Compound superclass provides the ability to combine widgets into a compound.
A compound widget can export its subordinate children to let you get and set their resources,
or it can block access to them to provide a “canned” appearance.
*/
class Compound:
public Container
{
Expand Down
6 changes: 5 additions & 1 deletion src/Container.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@

namespace PhWidgets
{

//! Layout and geometry management for all container widgets
/*!
The Container superclass provides layout and geometry management for all container widgets.
It also redirects certain events—such as button presses, releases, repeats, and keys—to the child that has focus.
*/
class Container:
public Basic
{
Expand Down
10 changes: 9 additions & 1 deletion src/Label.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,15 @@

namespace PhWidgets
{

//! A text, bitmap, or image label
/*!
The Label class provides a text string, bitmap, or image for labeling other widgets.
You can have text pop up in a balloon to provide further meaning to the label.
@see
- Button
- Text
*/
class Label:
public Basic
{
Expand Down
11 changes: 10 additions & 1 deletion src/Numeric.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,16 @@

namespace PhWidgets
{

//! A superclass for numeric widgets
/*!
Numeric is a parent class for all numeric widgets.
It creates a Text widget and arrows to let you interact with the widget.
It also creates some of the base functionality of numeric widgets.
@see
- NumericFloat
- NumericInteger
*/
class Numeric:
public Compound
{
Expand Down
7 changes: 6 additions & 1 deletion src/NumericFloat.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@

namespace PhWidgets
{

//! Floating-point numeric widget
/*!
The NumericFloat class is a numeric widget that lets you enter
floating-point values between given minimum and maximum values.
You can also use an incorporated Scrollbar to increase or decrease the value by a set amount.
*/
class NumericFloat:
public Numeric
{
Expand Down
5 changes: 4 additions & 1 deletion src/NumericInteger.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@

namespace PhWidgets
{

//! Integer numeric widget
/*!
The NumericInteger class lets you specify integer values between given minimum and maximum values.
*/
class NumericInteger: //TODO::implement all properties
public Numeric
{
Expand Down
6 changes: 5 additions & 1 deletion src/OnOffButton.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@

namespace PhWidgets
{

//! An on/off button that can be set or unset
/*!
A OnOffButton widget displays an on/off button that can be set or unset.
Instances of this class of widget are typically used in exclusive or nonexclusive groups.
*/
class OnOffButton:
public Button
{
Expand Down
7 changes: 6 additions & 1 deletion src/Text.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@

namespace PhWidgets
{

//! Single-line text
/*!
The Photon text widgets let you type textual information into a text-entry box.
The widgets provide basic editing features, so you can alter text that's entered.
They also support a point-and-click model of editing, so that you can operate on blocks of text as a unit.
*/
class Text:
public Label
{
Expand Down
2 changes: 1 addition & 1 deletion src/Timer.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

namespace PhWidgets
{
//! A widget that invokes a callback after a given length of time
//! A widget that invokes a callback after a given length of time
/*!
A Timer widget invokes a callback after an initial and repeated time period, given in milliseconds.
This widget is intended to provide a non-accurate, resourceless time base for your application.
Expand Down
6 changes: 5 additions & 1 deletion src/ToggleButton.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@

namespace PhWidgets
{

//! A toggle switch that's either off or on
/*!
A ToggleButton widget is like a toggle switch, although it behaves like a button.
It has on and off states, and pressing the button inverts the current state of the button.
*/
class ToggleButton:
public Button
{
Expand Down

0 comments on commit 162e25e

Please sign in to comment.