Crazy Eddies GUI System  0.7.0
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
CEGUI Namespace Reference

Main namespace for Crazy Eddie's GUI Library. More...

Namespaces

namespace  CheckboxProperties
 Namespace containing all classes that make up the properties interface for the Checkbox class.
 
namespace  ComboboxProperties
 Namespace containing all classes that make up the properties interface for the Combobox class.
 
namespace  EditboxProperties
 Namespace containing all classes that make up the properties interface for the Editbox class.
 
namespace  FalagardEditboxProperties
 Namespace containing the specialised Falagard properties for Editbox.
 
namespace  FalagardListHeaderProperties
 Properties for the Falagard ListHeader.
 
namespace  FalagardMultiLineEditboxProperties
 Namespace containing the specialised Falagard properties for MultiLineEditbox.
 
namespace  FalagardProgressBarProperties
 Namespace containing the specialised properties interface for the Progress Bar under Falagard class.
 
namespace  FalagardScrollbarProperties
 Namespace containing the specialised properties interface for the Scrollbar under Falagard class.
 
namespace  FalagardSliderProperties
 Namespace containing the specialised properties interface for the Slider under Falagard class.
 
namespace  FalagardStaticImageProperties
 Namespace containing all classes that make up the properties interface for the FalagardStaticText class.
 
namespace  FalagardStaticProperties
 Namespace containing all classes that make up the properties interface for the FalagardStatic (base) class.
 
namespace  FalagardStaticTextProperties
 Namespace containing all classes that make up the properties interface for the FalagardStaticText class.
 
namespace  FalagardTabControlProperties
 Properties for the Falagard TabControl.
 
namespace  FrameWindowProperties
 Namespace containing all classes that make up the properties interface for the FrameWindow class.
 
namespace  ItemEntryProperties
 Namespace containing all classes that make up the properties interface for the ItemEntry class.
 
namespace  ItemListBaseProperties
 Namespace containing all classes that make up the properties interface for the ItemListBase class.
 
namespace  ItemListboxProperties
 Namespace containing all classes that make up the properties interface for the ItemListbox class.
 
namespace  ListboxProperties
 Namespace containing all classes that make up the properties interface for the Listbox class.
 
namespace  ListHeaderProperties
 Namespace containing all classes that make up the properties interface for the ListHeader class.
 
namespace  ListHeaderSegmentProperties
 Namespace containing all classes that make up the properties interface for the ListHeaderSegment class.
 
namespace  MultiColumnListProperties
 Namespace containing all classes that make up the properties interface for the MultiColumnList class.
 
namespace  MultiLineEditboxProperties
 Namespace containing all classes that make up the properties interface for the MultiLineEditbox class.
 
namespace  ProgressBarProperties
 Namespace containing all classes that make up the properties interface for the ProgressBar class.
 
namespace  RadioButtonProperties
 Namespace containing all classes that make up the properties interface for the RadioButton class.
 
namespace  ScrollablePaneProperties
 Namespace containing all classes that make up the properties interface for the ScrollablePane class.
 
namespace  ScrollbarProperties
 Namespace containing all classes that make up the properties interface for the Scrollbar class.
 
namespace  ScrolledContainerProperties
 Namespace containing all classes that make up the properties interface for the ScrolledContainer class.
 
namespace  ScrolledItemListBaseProperties
 Namespace containing all classes that make up the properties interface for the ScrolledItemListBase class.
 
namespace  SliderProperties
 Namespace containing all classes that make up the properties interface for the Slider class.
 
namespace  TabControlProperties
 Namespace containing all classes that make up the properties interface for the Listbox class.
 
namespace  ThumbProperties
 Namespace containing all classes that make up the properties interface for the Thumb class.
 
namespace  TitlebarProperties
 Namespace containing all classes that make up the properties interface for the Titlebar class.
 
namespace  TooltipProperties
 Namespace containing all classes that make up the properties interface for the Tooltip class.
 
namespace  TreeProperties
 
Namespace containing classes that make up the properties interface specific

to the Tree class.

 
namespace  WindowProperties
 Namespace containing all classes that make up the properties interface for the Window base class.
 
namespace  XercesParserProperties
 Properties for the XercesParser XML parser module.
 

Classes

class  BasicRenderedStringParser
 Basic RenderedStringParser class that offers support for 'colour', 'font', 'image' and 'window' control tags. More...
 
class  BiDiVisualMapping
 Abstract class to wrap a BiDi visual mapping of a text string. More...
 
class  BoundSlot
 Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted. More...
 
class  CentredRenderedString
 FormattedRenderedString implementation that renders the RenderedString with centred formatting. More...
 
class  colour
 Class representing colour values within the system. More...
 
class  ColourRect
 Class that holds details of colours for the four corners of a rectangle. More...
 
class  Config_xmlHandler
 Handler class used to parse the Configuration XML file. More...
 
class  CoordConverter
 Utility class that helps in converting various types of co-ordinate between absolute screen positions and positions offset from the top-left corner of a given Window object. More...
 
class  RawDataContainer
 Class used as the databuffer for loading files throughout the library. More...
 
class  DefaultLogger
 
Default implementation for the Logger class.

If you want to redirect CEGUI logs to some place other than a text file, implement your own Logger implementation and create a object of the Logger type before creating the CEGUI::System singleton. More...

 
class  DefaultRenderedStringParser
 Effectively a 'null' parser that returns a RenderedString representation that will draw the input text verbatim. More...
 
class  DefaultResourceProvider
 
class  DynamicModule
 Class that wraps and gives access to a dynamically linked module (.dll, .so, etc...) More...
 
class  Event
 Defines an 'event' which can be subscribed to by interested parties. More...
 
class  EventArgs
 Base class used as the argument to all subscribers Event object. More...
 
class  EventSet
 Class that collects together a set of Event objects. More...
 
class  Exception
 Root exception class used within the GUI system. More...
 
class  GenericException
 Exception class used when none of the other classes are applicable. More...
 
class  UnknownObjectException
 Exception class used when a request was made for an unknown object. More...
 
class  InvalidRequestException
 Exception class used when some impossible request was made of the system. More...
 
class  FileIOException
 Exception class used when a file handling problem occurs. More...
 
class  RendererException
 Exception class used for problems in the rendering subsystem classes. More...
 
class  AlreadyExistsException
 Exception class used when an attempt is made create a named object of a particular type when an object of the same type already exists with the same name. More...
 
class  MemoryException
 Exception class used when a memory handling error is detected. More...
 
class  NullObjectException
 Exception class used when some required object or parameter is null. More...
 
class  ObjectInUseException
 Exception class used when some attempt to delete, remove, or otherwise invalidate some object that is still in use occurs. More...
 
class  ScriptException
 Exception class used for issues in scripting subsystem. More...
 
class  FactoryModule
 Class that encapsulates access to a dynamic loadable module containing implementations of Windows, Widgets, and their factories. More...
 
class  Font
 Class that encapsulates a typeface. More...
 
class  Font_xmlHandler
 Handler class used to parse the Font XML files to create Font objects. More...
 
class  FontGlyph
 internal class representing a single font glyph. More...
 
class  FontManager
 Class providing a shared library of Font objects to the system. More...
 
class  FormattedRenderedString
 Root of a class hierarchy that wrap RenderedString objects and render them with additional formatting. More...
 
class  FreeFunctionSlot
 Slot functor class that calls back via a free function pointer. More...
 
class  FreeTypeFont
 Implementation of the Font class interface using the FreeType library. More...
 
class  FribidiVisualMapping
 fribidi based implementation of BiDiVisualMapping. More...
 
class  FunctorCopySlot
 Slot template class that creates a functor that calls back via a copy of a functor object. More...
 
class  FunctorPointerSlot
 Slot template class that creates a functor that calls back via a functor object pointer. More...
 
struct  FunctorReferenceBinder
 Class that enables the creation of a reference binding for a functor object to be used as a callback slot. Wrap your functor with this to enable the use of an object reference when subscribing to an event signal (as opposed to the functor object being copied, or using a pointer). More...
 
class  FunctorReferenceSlot
 Slot template class that creates a functor that calls back via a functor object reference. More...
 
class  GeometryBuffer
 Abstract class defining the interface for objects that buffer geometry for later rendering. More...
 
class  GlobalEventSet
 The GlobalEventSet singleton allows you to subscribe to an event for all instances of a class. The GlobalEventSet effectively supports "late binding" to events; which means you can subscribe to some event that does not actually exist (yet). More...
 
class  GUILayout_xmlHandler
 Handler class used to parse the GUILayout XML files using SAX2. More...
 
class  Image
 Class that represents a single Image of an Imageset. More...
 
class  ImageCodec
 Abstract ImageLoader class. An image loader encapsulate the loading of a texture. More...
 
class  Imageset
 Offers functions to define, access, and draw, a set of image components on a single graphical surface or Texture. More...
 
class  Imageset_xmlHandler
 Class used to parse the Imageset XML files to create Imageset objects. More...
 
class  ImagesetManager
 Class providing a shared library of Imageset objects to the system. More...
 
struct  Key
 struct to give scope to scan code enumeration. More...
 
class  WindowEventArgs
 EventArgs based class that is used for objects passed to handlers triggered for events concerning some Window object. More...
 
class  UpdateEventArgs
 WindowEventArgs class that is primarily used by lua scripts. More...
 
class  MouseEventArgs
 EventArgs based class that is used for objects passed to input event handlers concerning mouse input. More...
 
class  MouseCursorEventArgs
 EventArgs based class that is used for objects passed to input event handlers concerning mouse cursor events. More...
 
class  KeyEventArgs
 EventArgs based class that is used for objects passed to input event handlers concerning keyboard input. More...
 
class  ActivationEventArgs
 EventArgs based class that is used for Activated and Deactivated window events. More...
 
class  DragDropEventArgs
 EventArgs based class used for certain drag/drop notifications. More...
 
class  DisplayEventArgs
 EventArgs based class that is used for notifications regarding the main display. More...
 
class  ResourceEventArgs
 EventArgs based class that is used for notifications regarding resources. More...
 
class  ConstBaseIterator
 Base class constant iterator used to offer iteration over various collections within the system. More...
 
class  JustifiedRenderedString
 FormattedRenderedString implementation that renders the RenderedString with justified formatting. More...
 
class  LeftAlignedRenderedString
 FormattedRenderedString implementation that renders the RenderedString with left aligned formatting. More...
 
class  Logger
 
Abstract class that defines the interface of a logger object for the GUI system.

The default implementation of this interface is the DefaultLogger class; if you want to perform special logging, derive your own class from Logger and initialize a object of that type before you create the CEGUI::System singleton. More...

 
class  MemberFunctionSlot
 Slot template class that creates a functor that calls back via a class member function. More...
 
class  MinibidiVisualMapping
 minibidi based implementation of BiDiVisualMapping. More...
 
class  MouseCursor
 Class that allows access to the GUI system mouse cursor. More...
 
class  ResourceEventSet
 implementation class to gather EventSet parts for all template instances. More...
 
class  NamedXMLResourceManager
 Templatised manager class that loads and manages named XML based resources. More...
 
class  PCRERegexMatcher
 Implementation of RegexMatcher using PCRE. More...
 
class  PixmapFont
 Implementation of the Font class interface using static Imageset's. More...
 
class  PropertyReceiver
 Dummy base class to ensure correct casting of receivers. More...
 
class  Property
 An abstract class that defines the interface to access object properties by name. More...
 
class  PropertyHelper
 Helper class used to convert various data types to and from the format expected in Propery strings. More...
 
class  PropertySet
 Class that contains a collection of Property objects. More...
 
class  Rect
 Class encapsulating operations on a Rectangle. More...
 
class  RefCounted
 Simple, generic, reference counted pointer class. This is primarily here for use by the Events system to track when to delete slot bindings. More...
 
class  RegexMatcher
 Interface for Regex matching support classes. More...
 
class  RenderedString
 Class representing a rendered string of entities. More...
 
class  RenderedStringComponent
 Base class representing a part of a rendered string. The 'part' represented may be a text string, an image or some other entity. More...
 
class  RenderedStringImageComponent
 String component that draws an image. More...
 
class  RenderedStringParser
 Specifies interface for classes that parse text into RenderedString objects. More...
 
class  RenderedStringTextComponent
 String component that draws an image. More...
 
class  RenderedStringWidgetComponent
 String component that moves a widget to appear as part of the string. More...
 
class  RenderedStringWordWrapper
 Class that handles wrapping of a rendered string into sub-strings. Each sub-string is rendered using the FormattedRenderedString based class 'T'. More...
 
class  RenderEffect
 Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved. More...
 
class  Renderer
 Abstract class defining the basic required interface for Renderer objects. More...
 
struct  RenderingContext
 struct that holds some context relating to a RenderingSurface object. More...
 
class  RenderingRoot
 
class  RenderQueueEventArgs
 EventArgs based class that is passed to handlers subcribed to hear about begin/end events on rendering queues that are part of a RenderingSurface object. More...
 
class  RenderingSurface
 Class that represents a surface that can have geometry based imagery drawn to it. More...
 
class  RenderingWindow
 RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is primarily intended to be used as a kind of cache for rendered imagery. More...
 
class  RenderQueue
 Class that represents a queue of GeometryBuffer objects to be rendered. More...
 
class  RenderTarget
 Defines interface to some surface that can be rendered to. Concrete instances of objects that implement the RenderTarget interface are normally created via the Renderer object. More...
 
class  ResourceProvider
 Abstract class that defines the required interface for all resource provider sub-classes. More...
 
class  RightAlignedRenderedString
 FormattedRenderedString implementation that renders the RenderedString with right aligned formatting. More...
 
class  Scheme
 A class that groups a set of GUI elements and initialises the system to access those elements. More...
 
class  Scheme_xmlHandler
 Handler class used to parse the Scheme XML files using SAX2. More...
 
class  SchemeManager
 A class that manages the creation of, access to, and destruction of GUI Scheme objects. More...
 
class  ScriptModule
 Abstract interface required for all scripting support modules to be used with the CEGUI system. More...
 
class  ScriptFunctor
 Functor class used for binding named script functions to events. More...
 
class  Singleton
 
class  Size
 Class that holds the size (width & height) of something. More...
 
class  SlotFunctorBase
 Defines abstract interface which will be used when constructing various functor objects that bind slots to signals (or in CEGUI terms, handlers to events). More...
 
class  String
 String class used within the GUI system. More...
 
class  SubscriberSlot
 SubscriberSlot class which is used when subscribing to events. More...
 
class  System
 The System class is the CEGUI class that provides access to all other elements in this system. More...
 
class  Texture
 Abstract base class specifying the required interface for Texture objects. More...
 
class  TextureTarget
 Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that are implemented using textures. More...
 
class  TextUtils
 Text utility support class. This class is all static members. You do not create instances of this class. More...
 
class  TplWindowFactory
 Template based WindowFactory that can be used to automatically generate a WindowFactory given a Window based class. More...
 
class  TplWindowRendererFactory
 Template based WindowRendererFactory that can be used to automatically generate a WindowRendererFactory given a WindowRenderer based class. More...
 
class  TplWRFactoryRegisterer
 Template based implementation of WRFactoryRegisterer that allows easy registration of a factory for any WindowRenderer type. More...
 
class  UDim
 Class representing a unified dimension; that is a dimension that has both a relative 'scale' portion and and absolute 'offset' portion. More...
 
class  UVector2
 Two dimensional vector class built using unified dimensions (UDims). The UVector2 class is used for representing both positions and sizes. More...
 
class  URect
 Area rectangle class built using unified dimensions (UDims). More...
 
class  Vector2
 Class used as a two dimensional vector (aka a Point) More...
 
class  Vector3
 Class used as a three dimensional vector. More...
 
struct  Vertex
 structure that is used to hold details of a single vertex in 3D space. More...
 
class  Window
 An abstract base class providing common functionality and specifying the required interface for derived classes. More...
 
class  WindowFactory
 Abstract class that defines the required interface for all WindowFactory objects. More...
 
class  WindowFactoryManager
 Class that manages WindowFactory objects. More...
 
class  WindowManager
 The WindowManager class describes an object that manages creation and lifetime of Window objects. More...
 
class  WindowRenderer
 Base-class for the assignable WindowRenderer object. More...
 
class  WindowRendererFactory
 Base-class for WindowRendererFactory. More...
 
class  WindowRendererManager
 
class  WindowRendererModule
 Abstract interface for window renderer module objects. More...
 
class  WRFactoryRegisterer
 Base class encapsulating a type name and common parts of WindowRenderer factory registration. More...
 
class  XMLAttributes
 Class representing a block of attributes associated with an XML element. More...
 
class  XMLHandler
 
class  XMLParser
 This is an abstract class that is used by CEGUI to interface with XML parser libraries. More...
 
class  XMLSerializer
 Class used to create XML Document. More...
 
class  ButtonBase
 Base class for all the 'button' type widgets (push button, radio button, check-box, etc) More...
 
class  Checkbox
 Base class providing logic for Check-box widgets. More...
 
class  ClippedContainer
 Helper container window that has configurable clipping. Used by the ItemListbox widget. More...
 
class  Combobox
 Base class for the Combobox widget. More...
 
class  ComboDropList
 Base class for the combo box drop down list. This is a specialisation of the Listbox class. More...
 
class  DragContainer
 Generic drag & drop enabled window class. More...
 
class  EditboxWindowRenderer
 Base class for the EditboxWindowRenderer class. More...
 
class  Editbox
 Base class for an Editbox widget. More...
 
class  FrameWindow
 Abstract base class for a movable, sizable, window with a title-bar and a frame. More...
 
class  GroupBox
 Base class for standard GroupBox widget. More...
 
class  GUISheet
 Window class intended to be used as a simple, generic Window. More...
 
class  ItemEntryWindowRenderer
 Base class for ItemEntry window renderer objects. More...
 
class  ItemEntry
 Base class for item type widgets. More...
 
class  ItemListBaseWindowRenderer
 Base class for ItemListBase window renderer. More...
 
class  ItemListBase
 Base class for item list widgets. More...
 
class  ItemListbox
 ItemListbox window class. More...
 
class  ListboxWindowRenderer
 Base class for Listbox window renderer. More...
 
class  Listbox
 Base class for standard Listbox widget. More...
 
class  ListboxItem
 Base class for list box items. More...
 
class  ListboxTextItem
 Class used for textual items in a list box. More...
 
class  HeaderSequenceEventArgs
 EventArgs class used for segment move (sequence changed) events. More...
 
class  ListHeaderWindowRenderer
 Base class for the multi column list header window renderer. More...
 
class  ListHeader
 Base class for the multi column list header widget. More...
 
class  ListHeaderSegment
 Base class for list header segment window. More...
 
class  Menubar
 Base class for menu bars. More...
 
class  MenuBase
 Abstract base class for menus. More...
 
class  MenuItem
 Base class for menu items. More...
 
struct  MCLGridRef
 Simple grid index structure. More...
 
class  MultiColumnListWindowRenderer
 Base class for the multi column list window renderer. More...
 
class  MultiColumnList
 Base class for the multi column list widget. More...
 
class  MultiLineEditboxWindowRenderer
 Base class for multi-line edit box window renderer objects. More...
 
class  MultiLineEditbox
 Base class for the multi-line edit box widget. More...
 
class  PopupMenu
 Base class for popup menus. More...
 
class  ProgressBar
 Base class for progress bars. More...
 
class  PushButton
 Base class to provide logic for push button type widgets. More...
 
class  RadioButton
 Base class to provide the logic for Radio Button widgets. More...
 
class  ScrollablePaneWindowRenderer
 Base class for ScrollablePane window renderer objects. More...
 
class  ScrollablePane
 Base class for the ScrollablePane widget. More...
 
class  ScrollbarWindowRenderer
 Base class for ItemEntry window renderer objects. More...
 
class  Scrollbar
 Base scroll bar class. More...
 
class  ScrolledContainer
 Helper container window class which is used in the implementation of the ScrollablePane widget class. More...
 
class  ScrolledItemListBase
 ScrolledItemListBase window class. More...
 
class  SliderWindowRenderer
 Base class for ItemEntry window renderer objects. More...
 
class  Slider
 Base class for Slider widgets. More...
 
class  Spinner
 Base class for the Spinner widget. More...
 
class  TabButton
 Base class for TabButtons. A TabButton based class is used internally as the button that appears at the top of a TabControl widget to select the active tab pane. More...
 
class  TabControlWindowRenderer
 Base class for TabControl window renderer objects. More...
 
class  TabControl
 Base class for standard Tab Control widget. More...
 
class  Thumb
 Base class for Thumb widget. More...
 
class  Titlebar
 Class representing the title bar for Frame Windows. More...
 
class  TooltipWindowRenderer
 Base class for Tooltip window renderer objects. More...
 
class  Tooltip
 Base class for Tooltip widgets. More...
 
class  TreeEventArgs
 EventArgs based class that is used for objects passed to input event handlers concerning Tree events. More...
 
class  Tree
 Base class for standard Tree widget. More...
 
class  TreeItem
 Base class for tree items. More...
 
class  Falagard_xmlHandler
 Handler class used to parse look & feel XML files used by the Falagard system. More...
 
class  FalagardComponentBase
 Common base class used for renderable components within an ImagerySection. More...
 
class  BaseDim
 Abstract interface for a generic 'dimension' class. More...
 
class  AbsoluteDim
 Dimension type that represents an absolute pixel value. Implements BaseDim interface. More...
 
class  ImageDim
 Dimension type that represents some dimension of a named Image. Implements BaseDim interface. More...
 
class  WidgetDim
 Dimension type that represents some dimension of a Window/widget. Implements BaseDim interface. More...
 
class  UnifiedDim
 Dimension type that represents an Unified dimension. Implements BaseDim interface. More...
 
class  FontDim
 Dimension type that represents some metric of a Font. Implements BaseDim interface. More...
 
class  PropertyDim
 Dimension type that represents the value of a Window property. Implements BaseDim interface. More...
 
class  Dimension
 Class representing some kind of dimension. More...
 
class  ComponentArea
 Class that represents a target area for a widget or imagery component. More...
 
class  FrameComponent
 Class that encapsulates information for a frame with background (9 images in total) More...
 
class  ImageryComponent
 Class that encapsulates information for a single image component. More...
 
class  ImagerySection
 Class that encapsulates a re-usable collection of imagery specifications. More...
 
class  LayerSpecification
 Class that encapsulates a single layer of imagery. More...
 
class  NamedArea
 NamedArea defines an area for a component which may later be obtained and referenced by a name unique to the WidgetLook holding the NamedArea. More...
 
class  PropertyDefinition
 Class representing a generic get/set property. More...
 
class  PropertyDefinitionBase
 common base class used for types representing a new property to be available on all widgets that use the WidgetLook that the property definition is a part of. More...
 
class  PropertyInitialiser
 Class that holds information about a property and it's required initial value. More...
 
class  PropertyLinkDefinition
 Class representing a property that links to another property defined on an attached child widget. More...
 
class  SectionSpecification
 Class that represents a simple 'link' to an ImagerySection. More...
 
class  StateImagery
 Class the encapsulates imagery for a given widget state. More...
 
class  TextComponent
 Class that encapsulates information for a text component. More...
 
class  WidgetComponent
 Class that encapsulates information regarding a sub-widget required for a widget. More...
 
class  WidgetLookFeel
 Class that encapsulates look & feel information for a particular widget type. More...
 
class  WidgetLookManager
 Manager class that gives top-level access to widget data based "look and feel" specifications loaded into the system. More...
 
class  FalagardXMLHelper
 Utility helper class primarily intended for use by the falagard xml parser. More...
 
class  CoronaImageCodec
 Image codec based on the Corona library. More...
 
class  DevILImageCodec
 Image codec based on the DevIL library. More...
 
class  FreeImageImageCodec
 Image codec based on the FreeImage library. More...
 
class  SILLYImageCodec
 Image codec based on the SILLY library. More...
 
class  TGAImageCodec
 Default image codec. More...
 
class  Direct3D10GeometryBuffer
 Implementation of CEGUI::GeometryBuffer for the Direct3D 10 API. More...
 
class  Direct3D10Renderer
 Renderer implementation using Direct3D 10. More...
 
class  Direct3D10RenderTarget
 Implementation of an ntermediate RenderTarget for the Direct3D 10 API. More...
 
class  Direct3D10Texture
 Texture implementation for the Direct3D10Renderer. More...
 
class  Direct3D10TextureTarget
 Direct3D10TextureTarget - allows rendering to Direct3D 10 textures. More...
 
class  Direct3D10ViewportTarget
 Direct3D10 based RenderTarget that represents the screen or a portion of it. More...
 
class  Direct3D9GeometryBuffer
 Direct3D9 based implementation of the GeometryBuffer interface. More...
 
class  Direct3D9Renderer
 Renderer class to interface with Direct3D 9. More...
 
class  Direct3D9RenderTarget
 Intermediate Direct3D9 implementation of a RenderTarget. More...
 
class  Direct3D9Texture
 Texture implementation for the Direct3D9Renderer. More...
 
class  Direct3D9TextureTarget
 Direct3D9TextureTarget - allows rendering to an Direct3D9 texture via . More...
 
class  Direct3D9ViewportTarget
 Direct3D9 RenderTarget that represents a screen viewport. More...
 
class  DirectFBGeometryBuffer
 Implemetation of CEGUI::GeometryBuffer for DirectFB. More...
 
class  DirectFBRenderer
 Implementation of CEGUI::Renderer interface using DirectFB. More...
 
class  DirectFBRenderTarget
 Implementation of CEGUI::RenderTarget for DirectFB. More...
 
class  DirectFBTexture
 Implementation of CEGUI::Texture interface using DirectFB. More...
 
class  IrrlichtEventPusher
 
class  IrrlichtGeometryBuffer
 GeometryBuffer implementation for the Irrlicht engine. More...
 
class  IrrlichtImageCodec
 ImageCodec object that loads data via image loading facilities in Irrlicht. More...
 
class  IrrlichtMemoryFile
 Class to wrap a file access interface around a memory buffer to enable us to pass data that has been loaded via the CEGUI::ResourceProvider to irrlicht, via it's IReadFile based interfaces. More...
 
class  IrrlichtRenderer
 CEGUI::Renderer implementation for the Irrlicht engine. More...
 
class  IrrlichtRenderTarget
 Intermediate RenderTarget implementing common parts for Irrlicht engine. More...
 
class  IrrlichtResourceProvider
 
class  IrrlichtTexture
 Implementation of the CEGUI::Texture class for the Irrlicht engine. More...
 
class  IrrlichtTextureTarget
 CEGUI::TextureTarget implementation for the Irrlicht engine. More...
 
class  IrrlichtWindowTarget
 CEGUI::RenderTarget that targets a window, or a part of a window. More...
 
class  OgreGeometryBuffer
 Implementation of CEGUI::GeometryBuffer for the Ogre engine. More...
 
class  OgreImageCodec
 ImageCodec object that loads data via image loading facilities in Ogre. More...
 
class  OgreRenderer
 CEGUI::Renderer implementation for the Ogre engine. More...
 
class  OgreRenderTarget
 Intermediate RenderTarget implementing common parts for Ogre engine. More...
 
class  OgreResourceProvider
 
class  OgreTexture
 Implementation of the CEGUI::Texture class for the Ogre engine. More...
 
class  OgreTextureTarget
 CEGUI::TextureTarget implementation for the Ogre engine. More...
 
class  OgreWindowTarget
 CEGUI::RenderTarget that targets an existing gre::RenderTarget. More...
 
class  OpenGLApplePBTextureTarget
 OpenGLApplePBTextureTarget - allows rendering to an OpenGL texture via the Apple pbuffer extension. More...
 
class  OpenGLFBOTextureTarget
 OpenGLFBOTextureTarget - allows rendering to an OpenGL texture via FBO. More...
 
class  OpenGLGeometryBuffer
 OpenGL based implementation of the GeometryBuffer interface. More...
 
class  OpenGLGLXPBTextureTarget
 OpenGLGLXPBTextureTarget - allows rendering to an OpenGL texture via the pbuffer provided in GLX 1.3 and above. More...
 
class  OpenGLRenderer
 Renderer class to interface with OpenGL. More...
 
class  OpenGLRenderTarget
 Intermediate OpenGL implementation of a RenderTarget. More...
 
class  OpenGLTexture
 Texture implementation for the OpenGLRenderer. More...
 
class  OpenGLViewportTarget
 OpenGL implementation of a RenderTarget that represents am on-scren viewport. More...
 
class  OpenGLWGLPBTextureTarget
 OpenGLWGLPBTextureTarget - allows rendering to an OpenGL texture via the pbuffer WGL extension. More...
 
class  LuaScriptModule
 Interface for the LuaScriptModule class. More...
 
class  LuaFunctor
 Functor class used for subscribing Lua functions to CEGUI events. More...
 
class  FalagardButton
 Button class for the FalagardBase module. More...
 
class  FalagardDefault
 Default class for the FalagardBase module. More...
 
class  FalagardEditbox
 Editbox class for the FalagardBase module. More...
 
class  FalagardFrameWindow
 FrameWindow class for the FalagardBase module. More...
 
class  FalagardItemEntry
 ItemEntry class for the FalagardBase module. More...
 
class  FalagardItemListbox
 ItemListbox class for the FalagardBase module. More...
 
class  FalagardListbox
 Listbox class for the FalagardBase module. More...
 
class  FalagardListHeader
 ListHeader class for the FalagardBase module. More...
 
class  FalagardListHeaderSegment
 ListHeaderSegment class for the FalagardBase module. More...
 
class  FalagardMenubar
 Menubar class for the FalagardBase module. More...
 
class  FalagardMenuItem
 MenuItem class for the FalagardBase module. More...
 
class  FalagardWRModule
 Implementation of WindowRendererModule for the Falagard window renderers. More...
 
class  FalagardMultiColumnList
 MultiColumnList class for the FalagardBase module. More...
 
class  FalagardMultiLineEditbox
 MultiLineEditbox class for the FalagardBase module. More...
 
class  FalagardPopupMenu
 PopupMenu class for the FalagardBase module. More...
 
class  FalagardProgressBar
 ProgressBar class for the FalagardBase module. More...
 
class  FalagardScrollablePane
 ScrollablePane class for the FalagardBase module. More...
 
class  FalagardScrollbar
 Scrollbar class for the FalagardBase module. More...
 
class  FalagardSlider
 Slider class for the FalagardBase module. More...
 
class  FalagardStatic
 Static class for the FalagardBase module. More...
 
class  FalagardStaticImage
 StaticImage class for the FalagardBase module. More...
 
class  FalagardStaticText
 StaticText class for the FalagardBase module. More...
 
class  FalagardSystemButton
 SystemButton class for the FalagardBase module. This class should be used for 'system' buttons on a FrameWindow, such as the close button. More...
 
class  FalagardTabButton
 TabButton class for the FalagardBase module. More...
 
class  FalagardTabControl
 TabControl class for the FalagardBase module. More...
 
class  FalagardTitlebar
 Titlebar class for the FalagardBase module. More...
 
class  FalagardToggleButton
 ToggleButton class for the FalagardBase module. More...
 
class  FalagardTooltip
 Tooltip class for the FalagardBase module. More...
 
class  FalagardTree
 Tree class for the FalagardBase module. More...
 
class  ExpatParser
 Implementation of XMLParser using Expat. More...
 
class  LibxmlParser
 Implementation of XMLParser using libxml. More...
 
class  TinyXMLParser
 Implementation of XMLParser using TinyXML. More...
 
class  XercesHandler
 
class  XercesParser
 Implementation of XMLParser using Xerces-C++. More...
 

Typedefs

typedef unsigned long ulong
 
typedef unsigned short ushort
 
typedef unsigned int uint
 
typedef unsigned char uchar
 
typedef unsigned int uint32
 
typedef unsigned short uint16
 
typedef unsigned char uint8
 
typedef std::ostream OutStream
 Output stream class.
 
typedef uint32 argb_t
 32 bit ARGB representation of a colour.
 
typedef uint8 utf8
 
typedef uint32 utf32
 
typedef Vector2 Point
 Point class.
 
typedef GUISheet DefaultWindow
 typedef for DefaultWindow, which is the new name for GUISheet.
 

Enumerations

enum  BidiCharType { BCT_RIGHT_TO_LEFT, BCT_LEFT_TO_RIGHT, BCT_NEUTRAL }
 Enumeration of possible character classes, used for bi-directional text.
 
enum  MouseButton {
  LeftButton, RightButton, MiddleButton, X1Button,
  X2Button, MouseButtonCount, NoButton
}
 Enumeration of mouse buttons. More...
 
enum  SystemKey {
  LeftMouse = 0x0001, RightMouse = 0x0002, Shift = 0x0004, Control = 0x0008,
  MiddleMouse = 0x0010, X1Mouse = 0x0020, X2Mouse = 0x0040, Alt = 0x0080
}
 System key flag values. More...
 
enum  LoggingLevel {
  Errors, Warnings, Standard, Informative,
  Insane
}
 Enumeration of logging levels. More...
 
enum  MouseCursorImage { BlankMouseCursor = 0, DefaultMouseCursor = -1 }
 Enumeration of special values used for mouse cursor settings in Window objects. More...
 
enum  XMLResourceExistsAction { XREA_RETURN, XREA_REPLACE, XREA_THROW }
 Possible actions when loading an XML resource that already exists. More...
 
enum  QuadSplitMode { TopLeftToBottomRight, BottomLeftToTopRight }
 Enumerated type that contains the valid diagonal-mode that specify how a quad is split into triangles when rendered with by a 3D API. More...
 
enum  RenderQueueID {
  RQ_USER_0, RQ_UNDERLAY, RQ_USER_1, RQ_BASE,
  RQ_USER_2, RQ_CONTENT_1, RQ_USER_3, RQ_CONTENT_2,
  RQ_USER_4, RQ_OVERLAY, RQ_USER_5
}
 Enumerated type for valid render queue IDs. More...
 
enum  VerticalAlignment { VA_TOP, VA_CENTRE, VA_BOTTOM }
 Enumerated type used when specifying vertical alignments. More...
 
enum  HorizontalAlignment { HA_LEFT, HA_CENTRE, HA_RIGHT }
 Enumerated type used when specifying horizontal alignments. More...
 
enum  DimensionType {
  DT_LEFT_EDGE, DT_X_POSITION, DT_TOP_EDGE, DT_Y_POSITION,
  DT_RIGHT_EDGE, DT_BOTTOM_EDGE, DT_WIDTH, DT_HEIGHT,
  DT_X_OFFSET, DT_Y_OFFSET, DT_INVALID
}
 Enumeration of possible values to indicate what a given dimension represents. More...
 
enum  VerticalFormatting {
  VF_TOP_ALIGNED, VF_CENTRE_ALIGNED, VF_BOTTOM_ALIGNED, VF_STRETCHED,
  VF_TILED
}
 Enumeration of possible values to indicate the vertical formatting to be used for an image component. More...
 
enum  HorizontalFormatting {
  HF_LEFT_ALIGNED, HF_CENTRE_ALIGNED, HF_RIGHT_ALIGNED, HF_STRETCHED,
  HF_TILED
}
 Enumeration of possible values to indicate the horizontal formatting to be used for an image component. More...
 
enum  VerticalTextFormatting { VTF_TOP_ALIGNED, VTF_CENTRE_ALIGNED, VTF_BOTTOM_ALIGNED }
 Enumeration of possible values to indicate the vertical formatting to be used for a text component. More...
 
enum  HorizontalTextFormatting {
  HTF_LEFT_ALIGNED, HTF_RIGHT_ALIGNED, HTF_CENTRE_ALIGNED, HTF_JUSTIFIED,
  HTF_WORDWRAP_LEFT_ALIGNED, HTF_WORDWRAP_RIGHT_ALIGNED, HTF_WORDWRAP_CENTRE_ALIGNED, HTF_WORDWRAP_JUSTIFIED
}
 Enumeration of possible values to indicate the horizontal formatting to be used for a text component. More...
 
enum  FontMetricType { FMT_LINE_SPACING, FMT_BASELINE, FMT_HORZ_EXTENT }
 Enumeration of possible values to indicate a particular font metric. More...
 
enum  DimensionOperator {
  DOP_NOOP, DOP_ADD, DOP_SUBTRACT, DOP_MULTIPLY,
  DOP_DIVIDE
}
 Enumeration of values representing mathematical operations on dimensions. More...
 
enum  FrameImageComponent {
  FIC_BACKGROUND, FIC_TOP_LEFT_CORNER, FIC_TOP_RIGHT_CORNER, FIC_BOTTOM_LEFT_CORNER,
  FIC_BOTTOM_RIGHT_CORNER, FIC_LEFT_EDGE, FIC_RIGHT_EDGE, FIC_TOP_EDGE,
  FIC_BOTTOM_EDGE, FIC_FRAME_IMAGE_COUNT
}
 Enumeration of values referencing available images forming a frame component. More...
 

Functions

bool CEGUIEXPORT operator== (const String &str1, const String &str2)
 Return true if String str1 is equal to String str2.
 
bool CEGUIEXPORT operator== (const String &str, const std::string &std_str)
 Return true if String str is equal to std::string std_str.
 
bool CEGUIEXPORT operator== (const std::string &std_str, const String &str)
 Return true if String str is equal to std::string std_str.
 
bool CEGUIEXPORT operator== (const String &str, const utf8 *utf8_str)
 Return true if String str is equal to null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator== (const utf8 *utf8_str, const String &str)
 Return true if String str is equal to null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator!= (const String &str1, const String &str2)
 Return true if String str1 is not equal to String str2.
 
bool CEGUIEXPORT operator!= (const String &str, const std::string &std_str)
 Return true if String str is not equal to std::string std_str.
 
bool CEGUIEXPORT operator!= (const std::string &std_str, const String &str)
 Return true if String str is not equal to std::string std_str.
 
bool CEGUIEXPORT operator!= (const String &str, const utf8 *utf8_str)
 Return true if String str is not equal to null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator!= (const utf8 *utf8_str, const String &str)
 Return true if String str is not equal to null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator< (const String &str1, const String &str2)
 Return true if String str1 is lexicographically less than String str2.
 
bool CEGUIEXPORT operator< (const String &str, const std::string &std_str)
 Return true if String str is lexicographically less than std::string std_str.
 
bool CEGUIEXPORT operator< (const std::string &std_str, const String &str)
 Return true if String str is lexicographically less than std::string std_str.
 
bool CEGUIEXPORT operator< (const String &str, const utf8 *utf8_str)
 Return true if String str is lexicographically less than null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator< (const utf8 *utf8_str, const String &str)
 Return true if String str is lexicographically less than null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator> (const String &str1, const String &str2)
 Return true if String str1 is lexicographically greater than String str2.
 
bool CEGUIEXPORT operator> (const String &str, const std::string &std_str)
 Return true if String str is lexicographically greater than std::string std_str.
 
bool CEGUIEXPORT operator> (const std::string &std_str, const String &str)
 Return true if String str is lexicographically greater than std::string std_str.
 
bool CEGUIEXPORT operator> (const String &str, const utf8 *utf8_str)
 Return true if String str is lexicographically greater than null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator> (const utf8 *utf8_str, const String &str)
 Return true if String str is lexicographically greater than null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator<= (const String &str1, const String &str2)
 Return true if String str1 is lexicographically less than or equal to String str2.
 
bool CEGUIEXPORT operator<= (const String &str, const std::string &std_str)
 Return true if String str is lexicographically less than or equal to std::string std_str.
 
bool CEGUIEXPORT operator<= (const std::string &std_str, const String &str)
 Return true if String str is lexicographically less than or equal to std::string std_str.
 
bool CEGUIEXPORT operator<= (const String &str, const utf8 *utf8_str)
 Return true if String str is lexicographically less than or equal to null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator<= (const utf8 *utf8_str, const String &str)
 Return true if String str is lexicographically less than or equal to null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator>= (const String &str1, const String &str2)
 Return true if String str1 is lexicographically greater than or equal to String str2.
 
bool CEGUIEXPORT operator>= (const String &str, const std::string &std_str)
 Return true if String str is lexicographically greater than or equal to std::string std_str.
 
bool CEGUIEXPORT operator>= (const std::string &std_str, const String &str)
 Return true if String str is lexicographically greater than or equal to std::string std_str.
 
bool CEGUIEXPORT operator>= (const String &str, const utf8 *utf8_str)
 Return true if String str is lexicographically greater than or equal to null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator>= (const utf8 *utf8_str, const String &str)
 Return true if String str is lexicographically greater than or equal to null-terminated utf8 data utf8_str.
 
bool CEGUIEXPORT operator== (const String &str, const char *c_str)
 Return true if String str is equal to c-string c_str.
 
bool CEGUIEXPORT operator== (const char *c_str, const String &str)
 Return true if c-string c_str is equal to String str.
 
bool CEGUIEXPORT operator!= (const String &str, const char *c_str)
 Return true if String str is not equal to c-string c_str.
 
bool CEGUIEXPORT operator!= (const char *c_str, const String &str)
 Return true if c-string c_str is not equal to String str.
 
bool CEGUIEXPORT operator< (const String &str, const char *c_str)
 Return true if String str is lexicographically less than c-string c_str.
 
bool CEGUIEXPORT operator< (const char *c_str, const String &str)
 Return true if c-string c_str is lexicographically less than String str.
 
bool CEGUIEXPORT operator> (const String &str, const char *c_str)
 Return true if String str is lexicographically greater than c-string c_str.
 
bool CEGUIEXPORT operator> (const char *c_str, const String &str)
 Return true if c-string c_str is lexicographically greater than String str.
 
bool CEGUIEXPORT operator<= (const String &str, const char *c_str)
 Return true if String str is lexicographically less than or equal to c-string c_str.
 
bool CEGUIEXPORT operator<= (const char *c_str, const String &str)
 Return true if c-string c_str is lexicographically less than or equal to String str.
 
bool CEGUIEXPORT operator>= (const String &str, const char *c_str)
 Return true if String str is lexicographically greater than or equal to c-string c_str.
 
bool CEGUIEXPORT operator>= (const char *c_str, const String &str)
 Return true if c-string c_str is lexicographically greater than or equal to String str.
 
String CEGUIEXPORT operator+ (const String &str1, const String &str2)
 Return String object that is the concatenation of the given inputs. More...
 
String CEGUIEXPORT operator+ (const String &str, const std::string &std_str)
 Return String object that is the concatenation of the given inputs. More...
 
String CEGUIEXPORT operator+ (const std::string &std_str, const String &str)
 Return String object that is the concatenation of the given inputs. More...
 
String CEGUIEXPORT operator+ (const String &str, const utf8 *utf8_str)
 Return String object that is the concatenation of the given inputs. More...
 
String CEGUIEXPORT operator+ (const utf8 *utf8_str, const String &str)
 Return String object that is the concatenation of the given inputs. More...
 
String CEGUIEXPORT operator+ (const String &str, utf32 code_point)
 Return String object that is the concatenation of the given inputs. More...
 
String CEGUIEXPORT operator+ (utf32 code_point, const String &str)
 Return String object that is the concatenation of the given inputs. More...
 
String CEGUIEXPORT operator+ (const String &str, const char *c_str)
 Return String object that is the concatenation of the given inputs. More...
 
String CEGUIEXPORT operator+ (const char *c_str, const String &str)
 Return String object that is the concatenation of the given inputs. More...
 
CEGUIEXPORT std::ostream & operator<< (std::ostream &s, const String &str)
 
void CEGUIEXPORT swap (String &str1, String &str2)
 Swap the contents for two String objects. More...
 
bool lbi_less (const ListboxItem *a, const ListboxItem *b)
 Helper function used in sorting to compare two list box item text strings via the ListboxItem pointers and return if a is less than b.
 
bool lbi_greater (const ListboxItem *a, const ListboxItem *b)
 Helper function used in sorting to compare two list box item text strings via the ListboxItem pointers and return if a is greater than b.
 
bool lbi_less (const TreeItem *a, const TreeItem *b)
 Helper function used in sorting to compare two tree item text strings via the TreeItem pointers and return if a is less than b.
 
bool lbi_greater (const TreeItem *a, const TreeItem *b)
 Helper function used in sorting to compare two tree item text strings via the TreeItem pointers and return if a is greater than b.
 

Variables

static const float DefaultNativeHorzRes = 640.0f
 Default native horizontal resolution (for fonts and imagesets)
 
static const float DefaultNativeVertRes = 480.0f
 Default native vertical resolution (for fonts and imagesets)
 

Detailed Description

Main namespace for Crazy Eddie's GUI Library.

The CEGUI namespace contains all the classes and other items that comprise the core of Crazy Eddie's GUI system.

Enumeration Type Documentation

Enumeration of values representing mathematical operations on dimensions.

Enumerator
DOP_NOOP 

Do nothing operator.

DOP_ADD 

Dims should be added.

DOP_SUBTRACT 

Dims should be subtracted.

DOP_MULTIPLY 

Dims should be multiplied.

DOP_DIVIDE 

Dims should be divided.

Enumeration of possible values to indicate what a given dimension represents.

Enumerator
DT_LEFT_EDGE 

Dimension represents the left edge of some entity (same as DT_X_POSITION).

DT_X_POSITION 

Dimension represents the x position of some entity (same as DT_LEFT_EDGE).

DT_TOP_EDGE 

Dimension represents the top edge of some entity (same as DT_Y_POSITION).

DT_Y_POSITION 

Dimension represents the y position of some entity (same as DT_TOP_EDGE).

DT_RIGHT_EDGE 

Dimension represents the right edge of some entity.

DT_BOTTOM_EDGE 

Dimension represents the bottom edge of some entity.

DT_WIDTH 

Dimension represents the width of some entity.

DT_HEIGHT 

Dimension represents the height of some entity.

DT_X_OFFSET 

Dimension represents the x offset of some entity (usually only applies to an Image entity).

DT_Y_OFFSET 

Dimension represents the y offset of some entity (usually only applies to an Image entity).

DT_INVALID 

Invalid / uninitialised DimensionType.

Enumeration of possible values to indicate a particular font metric.

Enumerator
FMT_LINE_SPACING 

Vertical line spacing value for font.

FMT_BASELINE 

Vertical baseline value for font.

FMT_HORZ_EXTENT 

Horizontal extent of a string.

Enumeration of values referencing available images forming a frame component.

Enumerator
FIC_BACKGROUND 

References image used for the background.

FIC_TOP_LEFT_CORNER 

References image used for the top-left corner.

FIC_TOP_RIGHT_CORNER 

References image used for the top-right corner.

FIC_BOTTOM_LEFT_CORNER 

References image used for the bottom-left corner.

FIC_BOTTOM_RIGHT_CORNER 

References image used for the bottom-right corner.

FIC_LEFT_EDGE 

References image used for the left edge.

FIC_RIGHT_EDGE 

References image used for the right edge.

FIC_TOP_EDGE 

References image used for the top edge.

FIC_BOTTOM_EDGE 

References image used for the bottom edge.

FIC_FRAME_IMAGE_COUNT 

Max number of images for a frame.

Enumerated type used when specifying horizontal alignments.

Enumerator
HA_LEFT 

Window's position specifies an offset of it's left edge from the left edge of it's parent.

HA_CENTRE 

Window's position specifies an offset of it's horizontal centre from the horizontal centre of it's parent.

HA_RIGHT 

Window's position specifies an offset of it's right edge from the right edge of it's parent.

Enumeration of possible values to indicate the horizontal formatting to be used for an image component.

Enumerator
HF_LEFT_ALIGNED 

Left of Image should be aligned with the left of the destination area.

HF_CENTRE_ALIGNED 

Image should be horizontally centred within the destination area.

HF_RIGHT_ALIGNED 

Right of Image should be aligned with the right of the destination area.

HF_STRETCHED 

Image should be stretched horizontally to fill the destination area.

HF_TILED 

Image should be tiled horizontally to fill the destination area (right-most tile may be clipped).

Enumeration of possible values to indicate the horizontal formatting to be used for a text component.

Enumerator
HTF_LEFT_ALIGNED 

Left of text should be aligned with the left of the destination area (single line of text only).

HTF_RIGHT_ALIGNED 

Right of text should be aligned with the right of the destination area (single line of text only).

HTF_CENTRE_ALIGNED 

text should be horizontally centred within the destination area (single line of text only).

HTF_JUSTIFIED 

text should be spaced so that it takes the full width of the destination area (single line of text only).

HTF_WORDWRAP_LEFT_ALIGNED 

Left of text should be aligned with the left of the destination area (word wrapped to multiple lines as needed).

HTF_WORDWRAP_RIGHT_ALIGNED 

Right of text should be aligned with the right of the destination area (word wrapped to multiple lines as needed).

HTF_WORDWRAP_CENTRE_ALIGNED 

text should be horizontally centred within the destination area (word wrapped to multiple lines as needed).

HTF_WORDWRAP_JUSTIFIED 

text should be spaced so that it takes the full width of the destination area (word wrapped to multiple lines as needed).

Enumeration of logging levels.

Enumerator
Errors 

Only actual error conditions will be logged.

Warnings 

Warnings will be logged as well.

Standard 

Basic events will be logged (default level).

Informative 

Useful tracing (object creations etc) information will be logged.

Insane 

Mostly everything gets logged (use for heavy tracing only, log WILL be big).

Enumeration of mouse buttons.

Enumerator
LeftButton 

The left mouse button.

RightButton 

The right mouse button.

MiddleButton 

The middle mouse button.

X1Button 

The first 'extra' mouse button.

X2Button 

The second 'extra' mouse button.

MouseButtonCount 

Value that equals the number of mouse buttons supported by CEGUI.

NoButton 

Value set for no mouse button. NB: This is not 0, do not assume!

Enumeration of special values used for mouse cursor settings in Window objects.

Enumerator
BlankMouseCursor 

No image should be displayed for the mouse cursor.

DefaultMouseCursor 

The default mouse cursor image should be displayed.

Enumerated type that contains the valid diagonal-mode that specify how a quad is split into triangles when rendered with by a 3D API.

Enumerator
TopLeftToBottomRight 

Diagonal split goes from top-left to bottom-right.

BottomLeftToTopRight 

Diagonal split goes from bottom-left to top-right.

Enumerated type for valid render queue IDs.

Enumerator
RQ_UNDERLAY 

Queue for rendering that appears beneath base imagery.

RQ_BASE 

Queue for base level rendering by the surface owner.

RQ_CONTENT_1 

Queue for first level of 'content' rendering.

RQ_CONTENT_2 

Queue for second level of 'content' rendering.

RQ_OVERLAY 

Queue for overlay rendering that appears above other regular rendering.

System key flag values.

Enumerator
LeftMouse 

The left mouse button.

RightMouse 

The right mouse button.

Shift 

Either shift key.

Control 

Either control key.

MiddleMouse 

The middle mouse button.

X1Mouse 

The first 'extra' mouse button.

X2Mouse 

The second 'extra' mouse button.

Alt 

Either alt key.

Enumerated type used when specifying vertical alignments.

Enumerator
VA_TOP 

Window's position specifies an offset of it's top edge from the top edge of it's parent.

VA_CENTRE 

Window's position specifies an offset of it's vertical centre from the vertical centre of it's parent.

VA_BOTTOM 

Window's position specifies an offset of it's bottom edge from the bottom edge of it's parent.

Enumeration of possible values to indicate the vertical formatting to be used for an image component.

Enumerator
VF_TOP_ALIGNED 

Top of Image should be aligned with the top of the destination area.

VF_CENTRE_ALIGNED 

Image should be vertically centred within the destination area.

VF_BOTTOM_ALIGNED 

Bottom of Image should be aligned with the bottom of the destination area.

VF_STRETCHED 

Image should be stretched vertically to fill the destination area.

VF_TILED 

Image should be tiled vertically to fill the destination area (bottom-most tile may be clipped).

Enumeration of possible values to indicate the vertical formatting to be used for a text component.

Enumerator
VTF_TOP_ALIGNED 

Top of text should be aligned with the top of the destination area.

VTF_CENTRE_ALIGNED 

text should be vertically centred within the destination area.

VTF_BOTTOM_ALIGNED 

Bottom of text should be aligned with the bottom of the destination area.

Possible actions when loading an XML resource that already exists.

Enumerator
XREA_RETURN 

Do not load the resource, return the existing instance.

XREA_REPLACE 

Destroy the existing instance and replace with the newly loaded one.

XREA_THROW 

Throw an AlreadyExistsException.

Function Documentation

String CEGUIEXPORT CEGUI::operator+ ( const String &  str1,
const String &  str2 
)

Return String object that is the concatenation of the given inputs.

Parameters
str1String object describing first part of the new string
str2String object describing the second part of the new string
Returns
A String object that is the concatenation of str1 and str2
Exceptions
std::length_errorThrown if the resulting String would be too large.
String CEGUIEXPORT CEGUI::operator+ ( const String &  str,
const std::string &  std_str 
)

Return String object that is the concatenation of the given inputs.

Parameters
strString object describing first part of the new string
std_strstd::string object describing the second part of the new string
Returns
A String object that is the concatenation of str and std_str
Exceptions
std::length_errorThrown if the resulting String would be too large.
String CEGUIEXPORT CEGUI::operator+ ( const std::string &  std_str,
const String &  str 
)

Return String object that is the concatenation of the given inputs.

Parameters
std_strstd::string object describing the first part of the new string
strString object describing the second part of the new string
Returns
A String object that is the concatenation of std_str and str
Exceptions
std::length_errorThrown if the resulting String would be too large.
String CEGUIEXPORT CEGUI::operator+ ( const String &  str,
const utf8 *  utf8_str 
)

Return String object that is the concatenation of the given inputs.

Parameters
strString object describing first part of the new string
utf8_strBuffer containing null-terminated utf8 encoded data describing the second part of the new string
Returns
A String object that is the concatenation of str and utf8_str
Exceptions
std::length_errorThrown if the resulting String would be too large.
String CEGUIEXPORT CEGUI::operator+ ( const utf8 *  utf8_str,
const String &  str 
)

Return String object that is the concatenation of the given inputs.

Parameters
utf8_strBuffer containing null-terminated utf8 encoded data describing the first part of the new string
strString object describing the second part of the new string
Returns
A String object that is the concatenation of str and utf8_str
Exceptions
std::length_errorThrown if the resulting String would be too large.
String CEGUIEXPORT CEGUI::operator+ ( const String &  str,
utf32  code_point 
)

Return String object that is the concatenation of the given inputs.

Parameters
strString object describing the first part of the new string
code_pointutf32 code point describing the second part of the new string
Returns
A String object that is the concatenation of str and code_point
Exceptions
std::length_errorThrown if the resulting String would be too large.
String CEGUIEXPORT CEGUI::operator+ ( utf32  code_point,
const String &  str 
)

Return String object that is the concatenation of the given inputs.

Parameters
code_pointutf32 code point describing the first part of the new string
strString object describing the second part of the new string
Returns
A String object that is the concatenation of code_point and str
Exceptions
std::length_errorThrown if the resulting String would be too large.
String CEGUIEXPORT CEGUI::operator+ ( const String &  str,
const char *  c_str 
)

Return String object that is the concatenation of the given inputs.

Parameters
strString object describing first part of the new string
c_strc-string describing the second part of the new string
Returns
A String object that is the concatenation of str and c_str
Exceptions
std::length_errorThrown if the resulting String would be too large.
String CEGUIEXPORT CEGUI::operator+ ( const char *  c_str,
const String &  str 
)

Return String object that is the concatenation of the given inputs.

Parameters
c_strc-string describing the first part of the new string
strString object describing the second part of the new string
Returns
A String object that is the concatenation of c_str and str
Exceptions
std::length_errorThrown if the resulting String would be too large.
void CEGUIEXPORT CEGUI::swap ( String &  str1,
String &  str2 
)

Swap the contents for two String objects.

Parameters
str1String object who's contents are to be swapped with str2
str2String object who's contents are to be swapped with str1
Returns
Nothing