omgui Namespace Reference

Classes

class App

class Button

class ButtonInitializer

A concrete initializer class for Button creation. More...

class ComboBox

class ComboBoxInitializer

A concrete initializer class for ComboBox creation. More...

class ComboBoxItem

class Connection

class ConnectionBody

class ConnectionImpl

class ConstMemberSlot

class DebugReport

Used like std::cout to print debug messages. When building with Visual Studio, debug messages will be printed to the Visual Studio debugger window. Otherwise, std::cout is used. More...

class EntryBox

class EntryBoxInitializer

A concrete initializer class for EntryBox creation. More...

class Event

class omgui::event_traits< Button >

class omgui::event_traits< Menu >

class omgui::event_traits< Notebook >

class omgui::event_traits< TextWidget >

class omgui::event_traits< Widget >

class omgui::event_traits< Window >

class EventLoop

class EventManager

class Exception

class FunctorSlot

class MemberSlot

class Menu

class MenuBar

class MenuEvent

class MenuItem

class MouseEvent

class Notebook

class NotebookEvent

class NotebookInitializer

A concrete initializer class for Notebook creation. More...

class Object

class Panel

class PanelInitializer

A concrete initializer class for Panel creation. More...

struct Point

Class representing a point using floating point values. More...

class Pointer

class PointerSlot

struct Rect

Data structure representing a rectangle, which is composed of an origin position and a size. More...

class RefCountable

class RefCounted

Implements RefCountable as simply as possible. More...

class SecureEntryBox

class SecureEntryBoxInitializer

A concrete initializer class for SecureEntryBox creation. More...

class Separator

class Signal

struct Size

Data structure representing a size using floating point values. More...

class SlotBase

class SystemError

class TableLayout

class TableLayoutInfo

class TableLayoutInitializer

A concrete initializer class for TableLayout creation. More...

class TextBox

class TextBoxInitializer

A concrete initializer class for TextBox creation. More...

struct TextRange

class TextWidget

class TopLevel

class Widget

Serves as the base class for all Widgets. More...

class Window

class WindowCloseEvent

class WindowInitializer

A concrete initializer class for Window creation. More...

Namespaces

namespace api

namespace cocoa

namespace common

namespace factory

namespace gtk2

namespace initializer

namespace win32

Typedefs

typedef std::list< Pointer
< omgui::Widget > > ChildList

typedef int event_id

event identifier

typedef omgui::App *( main_ptr )(const omgui::App::cmd_line &)

typedef unsigned short menu_id

typedef Pointer< Panel > NotebookPage

typedef int object_id

typedef std::map< object_id,
Object * > ObjectMap

typedef std::string string

typedef std::stringstream stringstream

typedef int text_range_t

typedef std::list< Pointer
< TopLevel > > TopLevelList

Enumerations

enum LAYOUT_FLAGS {
 ALIGN_LEFT = 0x01, ALIGN_RIGHT = 0x02, ALIGN_CENTER_HORIZONTAL = 0x04, ALIGN_TOP = 0x08,
 ALIGN_BOTTOM = 0x10, ALIGN_CENTER_VERTICAL = 0x20, ALIGN_CENTER = ALIGN_CENTER_HORIZONTAL | ALIGN_CENTER_VERTICAL, EXPAND_HORIZONTAL = 0x40,
 EXPAND_VERTICAL = 0x80, EXPAND_BOTH = EXPAND_HORIZONTAL | EXPAND_VERTICAL
}

Flags controlling the placement of the Widget within the layout. These flags are used by TableLayoutInfo and TableLayout. More...

Functions

int entry (omgui::main_ptr main, int argc, char *argv[])

omgui::App & get_app ()

Object * get_object_from_id (object_id id)

event_id get_unique_event_id ()

omgui::App * main (const omgui::App::cmd_line &cmd)

template<typename E, typename Functor>

SlotBase * make_slot (const Functor &func)

template<typename E, typename T>

SlotBase * make_slot (typename ConstMemberSlot< E, T >::function_type func, T &instance)

template<typename E, typename T>

SlotBase * make_slot (typename MemberSlot< E, T >::function_type func, T &instance)

template<typename E>

SlotBase * make_slot (typename PointerSlot< E >::function_type const &func)

template<typename T, typename U>

bool operator!= (T *lhs, const Pointer &rhs)

template<typename T, typename U>

bool operator!= (const Pointer< T > &lhs, U *rhs)

template<typename T, typename U>

bool operator!= (const Pointer< T > &lhs, const Pointer &rhs)

template<typename T>

bool operator< (const Pointer< T > &lhs, const Pointer< T > &rhs)

template<typename T, typename U>

bool operator== (T *lhs, const Pointer &rhs)

template<typename T, typename U>

bool operator== (const Pointer< T > &lhs, U *rhs)

template<typename T, typename U>

bool operator== (const Pointer< T > &lhs, const Pointer &rhs)

template<typename U>

void swap (Pointer &lhs, Pointer &rhs)

Variables

const event_id EVENT_ID_ANY = 0

const object_id OBJECT_ID_ANY = 0

ObjectMap object_map

TopLevelList top_level_widgets

Slot Priorities

Slots connected with a higher priority (a lower value) are signaled before those with lower priority (a higher value). These constants are defined to provide some preset priority levels. Custum priority levels are allowed. Any priority level higher than RUN_FIRST is discouraged.

const int SIGNAL_PRIORITY_HIGHER = 9

const int SIGNAL_PRIORITY_LOWER = 11

const int SIGNAL_PRIORITY_NORMAL = 10

This is the default priority.

const int SIGNAL_PRIORITY_RUN_FIRST = 1

const int SIGNAL_PRIORITY_RUN_LAST = 20

Typedef Documentation

typedef std::list< Pointer<omgui::Widget> > omgui::ChildList

typedef int omgui::event_id

event identifier

typedef omgui::App*( omgui::main_ptr)(const omgui::App::cmd_line &)

typedef unsigned short omgui::menu_id

Represents a menu identifier, an integral value associated with each menu item. When the menu item is selected, the menu_id of the selected item is used to determine the appropriate action to take.

typedef Pointer<Panel> omgui::NotebookPage

typedef int omgui::object_id

typedef std::map<object_id, Object*> omgui::ObjectMap [static]

typedef std::string omgui::string

typedef std::stringstream omgui::stringstream

typedef int omgui::text_range_t

typedef std::list< Pointer<TopLevel> > omgui::TopLevelList

Enumeration Type Documentation

enum omgui::LAYOUT_FLAGS

Flags controlling the placement of the Widget within the layout. These flags are used by TableLayoutInfo and TableLayout.

Mutually exclusive flags: {ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER_HORIZONTALORIZONTAL} {ALIGN_TOP, ALIGN_BOTTOM, ALIGN_CENTER_VERTICALERTICAL} Combinations of mutually exclusive flags will result in undefined behavior.

If no flags are specified, the default combation of flags is ALIGN_LEFT | ALIGN_TOP.

If a combination of EXPAND flags and ALIGN flags are made which both effect the same axis (horizontal or vertical), the EXPAND flag will have priority unless the maximal size of a Widget is exceeded, in which case the EXPAND flag will be ignored and the ALIGN flag will be used instead.

If an EXPAND flag was set but no ALIGN flag was set and a Widgets maximal size is exceeded, the EXPAND flag will be ignored and ALIGN_LEFT | ALIGN_TOP is assumed.

Enumerator:

ALIGN_LEFT
ALIGN_RIGHT
ALIGN_CENTER_HORIZONTAL
ALIGN_TOP
ALIGN_BOTTOM
ALIGN_CENTER_VERTICAL
ALIGN_CENTER
EXPAND_HORIZONTAL
EXPAND_VERTICAL
EXPAND_BOTH

Function Documentation

int omgui::entry	(	omgui::main_ptr	main,
		int	argc,
		char *	argv[]
	)

T & omgui::get_app ( ) [inline]

Returns:: A reference to the omgui::App object that is running this application.

Convenience template to save casting the return value of get_app to your derived application type.

T * omgui::get_object_from_id ( object_id id ) [inline]

Retrieves a pointer to the Object with the given object_id. If the object_id is invalid, a null pointer will be returned.

Convenience function to cast the return value of get_object_from_id

event_id omgui::get_unique_event_id ( )

This function generates a unique event id.

Returns:: A unique event id

omgui::App* omgui::main ( const omgui::App::cmd_line & cmd )

Called by the library, implemented by an application. The purpose of this function is to return a omgui::App derived object which will be used to run the application.

template<typename E, typename Functor>

SlotBase* omgui::make_slot ( const Functor & func ) [inline]

This overload is provided to support generic function objects. It can be used with anything ranging from function binders available in the standard C++ library, boost::bind, boost::function, or any type that is copy constructable and defines the appropriate operator().

template<typename E, typename T>

SlotBase* omgui::make_slot	(	typename ConstMemberSlot< E, T >::function_type	func,
		T &	instance
	)			`[inline]`

This overload works with const member function pointers.

template<typename E, typename T>

SlotBase* omgui::make_slot	(	typename MemberSlot< E, T >::function_type	func,
		T &	instance
	)			`[inline]`

This overload works with member function pointers.

template<typename E>

SlotBase* omgui::make_slot ( typename PointerSlot< E >::function_type const & func ) [inline]

This is a helper function to simplify the creation of slot objects. It has several overloads to work with plain old function pointers as well as member pointers and generic function objects.