OpenGUI Namespace Reference


Detailed Description

All OpenGUI classes are contained under the "OpenGUI" namespace.


Classes

class  BrushPrimitive
 Provides drawing methods for a few geometric primitives. More...
class  BrushImagery
 Provides methods for drawing Imagery covered rects. More...
class  BrushText
 Provides methods for rendering text. More...
class  Brush
 The base of all widget rendering operations. More...
class  Draw_EventArgs
 Specialization of EventArgs for Draw events. More...
class  Brush_Caching
 Brush that caches its output to RTT surfaces if available, with automatic fall back to memory storage if necessary. More...
class  Brush_Memory
 Brush that caches its output to memory. More...
class  Brush_RTT
 Brush that renders its output to a RenderTexture. More...
class  ContainerControl
 base class for all Controls that are also containers More...
class  Control
 Base class for all GUI objects that have position and size. More...
class  DrawCursor_EventArgs
 Specialization of Draw_EventArgs for Cursor objects. More...
class  Cursor
 Base class for cursors. More...
class  CursorManager
 Provides Cursor registration and definition functionality. More...
class  EventArgs
 Base class for event arguments. More...
class  Focus_EventArgs
 Base class for event arguments. More...
class  Input_EventArgs
 Base class for input related events. More...
class  Attach_EventArgs
 Specialization of EventArgs for Attach/Detach events. More...
class  Cursor_EventArgs
 Specialization of EventArgs for Cursor events. More...
class  Key_EventArgs
 Specialization of EventArgs for Key events. More...
class  Moved_EventArgs
 Specialization of EventArgs for Control Moved events. More...
class  Resized_EventArgs
 Specialization of EventArgs for Control Size events. More...
class  EventReceiver
 Provides a unified event definition, binding, and relaying service. More...
class  EventHandler
 Base class for custom event handler implementations. More...
class  EventHandlerList
 Provides event handler multi cast service. More...
class  EventCallback
 Self destroying C-callback style event delegate. More...
class  EventDelegate
 Self destroying multi-purpose event delegate. More...
class  Exception
 The only Exception class OpenGUI currently uses. More...
class  Slice
 A single slice within a Face. Can span multiple columns and rows. More...
class  Face
 Provides an HTML table like system for controlled stretching and tiling of logical groups of display imagery. More...
class  SliceDef
 Used with FaceDef to define the attributes of a Slice within a Face. More...
class  FaceDef
 Represents Face definitions, which are later used to create Face objects. More...
class  Font
 A handle representing font type and size. More...
class  FontManager
 Provides font loading and texture UV generation for glyphs loaded from fonts. More...
class  FontSet
 Used to load fonts and render glyphs from those fonts into memory segments. More...
class  FormEntry
 The base unit that comprises FormDefinition objects. More...
class  FormManager
 Manages creating, destroying, and lookup of FormDefinition objects. More...
class  GenericCursor
 A generic Cursor implementation based on static Imagery. More...
class  GenericResourceProvider
 This is the defailt generic implementation of the resource provider. More...
class  Imagery
 Defines a sub area of an Imageset. More...
class  ImageryManager
 Provides management services for loading, unloading, keeping track of, and searching for Imageset and the children Image objects.
[Singleton]. More...
class  Imageset
 Imagesets directly represent entire image files. They contain Imagery, which provide a usable window of the image file. More...
class  VectorIterator
 This is a generic vector iterator encapsulation class. More...
class  MapIterator
 This is a generic map iterator encapsulation class. More...
class  ListIterator
 This is a generic list iterator encapsulation class. More...
class  LogListener
 LogListener interface class for creating custom log output streams. More...
class  LogManager
 Central log manager. Logging messages can be sent through this object, or a specific Log object. More...
class  Log
 A log represents a categorization type for messages. Each log is given its own logLevel setting, in addition to the setLevel of the LogManager. More...
class  LogListenerToFile
 Default implementation of a LogListener. This one simply writes to a file, truncating it on open. More...
class  Math
 Provides math library functions in an inline-able yet abstracted form. More...
class  Object
 Base class for all GUI objects. Provides an exposed interface to the Accessor and Event systems. More...
class  ObjectAccessor
 Base class for Accessor system. More...
class  ObjectProperty
 Base class for Property Accessors. More...
class  ObjectMethod
 Base class for Method Accessors. More...
class  ObjectAccessorList
 The ObjectAccessorList is a inheritance capable string -> ObjectAccessor mapping. More...
class  PluginManager
 Plugin manager for tracking the proper loading and unloading of plugins. More...
class  RefObject
 Base abstract class for reference counted objects. More...
class  RefObjHandle
 Handle object for RefObject derived classes. More...
class  RefPtr
 This is the base template used for any reference counted pointers in OpenGUI. More...
class  Renderer
 Base class for all renderers. Any custom Renderer should inherit this base class. More...
class  Vertex
 It's a vertex. A Triangle consists of 3 of these. More...
class  Triangle
 Triangle. Wow. More...
class  RenderOperation
 These are the representations of render operations that are sent to the renderer for drawing. More...
class  RenderTexture
 This is a base class for render textures (textures that are valid render targets). More...
class  Resource
 The generic resource container. More...
class  Resource_CStr
 The same as Resource, except it provides access to the data as a C String. More...
class  ResourceProvider
 Abstract class. Used as a base class for custom resource providers. More...
class  Screen
 Every GUI is built into a screen. More...
class  ScreenManager
 Manages creating, destroying, and lookup of Screen objects. More...
class  StrConv
 String Converter providing conversions back and forth between strings and both common and OpenGUI specific types, and a few minor utility functions. More...
class  System
 The System object is the base of the OpenGUI project. It is responsible for initializing and destroying the various subsystems, and provides some functions to perform global activities, such as loading plugins and performing mass updates for all Screen objects.
[Singleton]. More...
class  Texture
 This is a base class for custom Texture implementations. Custom Renderer implementations will also quite likely include a custom Texture implementation to deal with API specific texture handling. More...
class  TextureData
 Represents in memory Texture data. Also provides built-in loading of BMP, GIF, JPEG, PCX, PNG, and TGA image files (via the current ResourceProvider), into a known data format so that textures can be created from them. More...
class  TDRColor
 Used to represent colors for a few functions within TextureDataRect. More...
class  TextureDataRect
 Provides a clean and reliable method of altering the contents of a TextureData object. More...
class  TextureManager
 Provides a common interface for creating textures from various sources.
[Singleton]. More...
class  Timer
 Timers provide a simple method of retrieving time deltas from the TimerManager. More...
class  TimerManager
 Provides timing services for OpenGUI widgets and applications.
[Singleton]. More...
class  Radian
 Represents radians and provide some basic utility functions. More...
class  Degree
 Represents degrees and provide some basic utility functions. More...
class  IVector2
 IVector2s are two dimensional vectors based on integers. More...
class  IRect
 IRects are rects built from int values. Internally they are comprised of two IVector2's. More...
class  FVector2
 The FVector2 is a two dimensional vector based on floats. More...
class  FRect
 FRects are rects built from float values. Internally they are comprised of two FVector2's. More...
class  TextAlignment
 This type is used throughout OpenGUI to represent horizontal and vertical text alignment. More...
class  Color
 Used throughout OpenGUI to define colors. More...
class  AutoArray2D
 An auto growing 2d array of whatever you want. More...
class  Value
 An encapsulation class used for passing values back and forth in the Accessor system. More...
class  ValueList
 Container of multiple Value objects. Provides stack, and name based access. More...
class  Viewport
 Final rendering surface for Screen objects. More...
class  Widget
 Base class for all input processing, containable, and potentially visible GUI objects. More...
class  WidgetCollection
 Ordered collection of Widget objects. More...
class  WidgetCollectionListener
 Interface for objects that contain collections of children Widget objects. More...
class  WidgetManager
 Provides Widget registration and definition functionality. More...
class  WindowResizeBeginEventArgs
 EventArgs used for "Resize_Begin" event. More...
class  Window
 base class for Windows More...
class  XMLNodeContainer
 Interface class for classes that contain XMLNode children. More...
class  XMLDoc
 Root level container for XML documents. More...
class  XMLNode
 Represents an XML tag. More...
class  XMLParser
 Provides XML tag registration and processing callback services. More...

Typedefs

typedef RefPtr< CursorCursorPtr
 Reference counted, auto deleting Cursor pointer.
typedef CursorPtr CursorFactoryCallback ()
 Cursor factory callback declaration/template.
typedef RefPtr< FaceFacePtr
 Reference counted, auto deleting Face pointer.
typedef std::list< SliceSliceList
 list of Slices from a Face
typedef std::vector< float > FaceDimArray
 Array of float dimensions representing column or row size in a Face.
typedef RefPtr< ImageryImageryPtr
 Reference counted, auto deleting Imagery pointer.
typedef std::list< ImageryPtrImageryPtrList
 list of ImageryPtrs
typedef RefObjHandle< ImagesetImagesetPtr
 Handle to the reference counted, auto deleting Imageset object.
typedef std::list< ImagesetPtrImagesetPtrList
 List of ImagesetPtr.
typedef std::list< TriangleTriangleList
 TriangleList. More Wow.
typedef std::list< std::string > StringList
 A list of strings.
typedef RefObjHandle< TextureTexturePtr
 A self deleting reference counted pointer for Texture objects.
typedef RefPtr< TimerTimerPtr
 Reference counted, auto deleting Timer pointer.
typedef std::list< Widget * > WidgetPtrList
 List of Widget pointers.
typedef WidgetWidgetFactoryCallback ()
 Widget factory callback declaration/template.
typedef std::list< XMLNode * > XMLNodeList
 List of XMLNode pointers.
typedef std::map< std::string,
std::string > 
XMLAttributeMap
 Map of attributes.
typedef bool XMLNodeHandler (const XMLNode &node, const std::string &nodePath)
 Callback signature for XML load/unload handlers.


Typedef Documentation

typedef RefPtr<Cursor> OpenGUI::CursorPtr

Reference counted, auto deleting Cursor pointer.

typedef CursorPtr OpenGUI::CursorFactoryCallback()

Cursor factory callback declaration/template.

typedef RefPtr<Face> OpenGUI::FacePtr

Reference counted, auto deleting Face pointer.

typedef std::list<Slice> OpenGUI::SliceList

list of Slices from a Face

typedef std::vector<float> OpenGUI::FaceDimArray

Array of float dimensions representing column or row size in a Face.

typedef RefPtr<Imagery> OpenGUI::ImageryPtr

Reference counted, auto deleting Imagery pointer.

typedef std::list<ImageryPtr> OpenGUI::ImageryPtrList

list of ImageryPtrs

typedef RefObjHandle<Imageset> OpenGUI::ImagesetPtr

Handle to the reference counted, auto deleting Imageset object.

typedef std::list<ImagesetPtr> OpenGUI::ImagesetPtrList

List of ImagesetPtr.

typedef std::list<Triangle> OpenGUI::TriangleList

TriangleList. More Wow.

typedef std::list<std::string> OpenGUI::StringList

A list of strings.

typedef RefObjHandle<Texture> OpenGUI::TexturePtr

A self deleting reference counted pointer for Texture objects.

typedef RefPtr<Timer> OpenGUI::TimerPtr

Reference counted, auto deleting Timer pointer.

typedef std::list<Widget*> OpenGUI::WidgetPtrList

List of Widget pointers.

typedef Widget* OpenGUI::WidgetFactoryCallback()

Widget factory callback declaration/template.

typedef std::list<XMLNode*> OpenGUI::XMLNodeList

List of XMLNode pointers.

typedef std::map<std::string, std::string> OpenGUI::XMLAttributeMap

Map of attributes.

typedef bool OpenGUI::XMLNodeHandler(const XMLNode &node, const std::string &nodePath)

Callback signature for XML load/unload handlers.

The handler callback is called for each tag that matches its registered tag name. The nodePath is sent to the handler so that it can determine if it is interested in handling each particular tag. If a handler does not process a tag when asked (signified by returning false), the next previously registered handler for that tag is called. This process continues until either the tag was handled, or XMLParser runs out of registered handlers for the tag (in which case it will log a warning about the unhandled tag and continue processing).

Parameters:
node Reference to the node that spawned the handler callback.
nodePath The current nodePath leading up to this node, but not including it.
Returns:
true if you handled the tag, false if you didn't (in which case the next registered handler for that tag will have the opportunity to handle it)


Copyright © 2006 OpenGUI | OpenGUI.SF.net
Generated: Fri Jan 5 23:05:24 2007