UI Namespace Reference

Classes
class	EqnPanel
class	Graphics
class	KeyEvent
class	MenuXML
class	MiloApp
class	MiloPanel
class	MiloWindow
class	MouseEvent

Typedefs
using	Keyboard = Keys::Key_Values
using	panel_factory = MiloPanelPtr(*)(const std::string &)
UI namespace Type Declerations
using	MiloWindowPtr = SmartPtr< MiloWindow >
	Smart pointer for MiloWindow.
using	MiloWindowVector = SmartVector< MiloWindow >
	Storage of MiloWindow pointers.
using	MiloWindowIter = MiloWindowVector::iterator
	Iterator of MiloWindow pointers vector.
using	MiloPanelPtr = SmartPtr< MiloPanel >
	Smart pointer for MiloPanel.
using	MiloPanelVector = SmartVector< MiloPanel >
	Storage of MiloPanel pointers.
using	MiloPanelIter = MiloPanelVector::iterator
	Iterator of MiloPanel pointers vector.
using	menu_handler = void(*)(void)

Enumerations
enum	Mouse {   NO_MOUSE, POSITION, PRESSED, RELEASED,   CLICKED, DOUBLE }
enum	Modifiers {   NO_MOD, ALT, SHIFT, ALT_SHIFT,   CTRL, CRL_ALT, CTRL_SHIFT, CTRL_ALT_SHIFT }

Functions
bool	operator== (const MouseEvent &m1, const MouseEvent &m2)
bool	operator== (const KeyEvent &k1, const KeyEvent &k2)
template<class T >
MiloPanelPtr	createPanel (const std::string &init)

Detailed Description

User Interface for milo namespace. This is the user interface for milo for porting to paticular interfaces.

Typedef Documentation

using UI::menu_handler = typedef void (*)(void)

Function pointer to handle a menu item. Return true, if event changed panel.

Enumeration Type Documentation

enum UI::Modifiers

Modifier key states for mouse and key events.

enum UI::Mouse

All possible mouse events.

Function Documentation

template<class T >

MiloPanelPtr UI::createPanel

(

const std::string &

init

)

Template function to create a smart pointer of a particular type

Parameters

init	String to initialize panel

Returns

Smart pointer to panel

bool UI::operator== ( const MouseEvent &  m1, const MouseEvent &  m2  )

inline

Overloading == operator for class MouseEvent

Parameters

m1	First mouse event
m2	Second mouse event

Returns

True if m1 == m2

bool UI::operator== ( const KeyEvent &  k1, const KeyEvent &  k2  )

inline

Overloading == operator for class KeyEvent

Parameters

m1	First key event
m2	Second key event

Returns

True if k1 == k2