ifm Namespace Reference

Detailed Description

The Interface Management System namespace.


Classes

class  CaptionButton
class  Color
 Gui toolkit independant representation of a color. More...
class  Component
 Base class for all components in IFM. More...
class  ComponentFactory
 Constructs component instances. More...
class  Container
 A Container is a Component that contains other Components as children. More...
class  ContainerFactory
 Constructs Container instances. More...
class  DefaultDockManager
 Implements the default docking behavior. More...
class  DefaultTheme
 The default theme implementation. More...
class  DeviceContextAdapter
 The gui toolkit independant interface for device contexts and painting operations. More...
class  Dimensions
class  DockManager
 Defines the basic interface for DockManagers. More...
class  DockTarget
class  InterfaceManager
 Manages docking for a Window. More...
class  MouseEventData
class  Panel
 A Panel is a component which contains a child Widget. More...
class  PanelFactory
 Constructs Panel instances. More...
class  Point
 Gui toolkit independant representation of a point. More...
class  Pointer
class  Rect
 Gui toolkit independant representation of rect. More...
class  Renderer
 Renders components. More...
class  Sash
class  Size
 Gui toolkit independant representation of a size. More...
class  Tab
class  TabbedContainer
 A TabbedContainer displays its children by creating a tab for each child allowing the user to select one tab at a time. More...
class  TabbedContainerFactory
 Constructs TabbedContainer instances. More...
class  Theme
 Represents a color theme for rendering interface. More...
class  WidgetAdapter
 The gui toolkit independant interface for widgets. More...

Namespaces

namespace  layout
 Contains objects that represent an interface state.
namespace  wx
 Contains wxWidgets implementation details.

Typedefs

typedef wxBitmap Bitmap
typedef wxBitmap * BitmapPtr
typedef std::map< int, Color > ColorMap
typedef int component_type
 Specifies a component type identifier.
typedef std::list< Pointer
< Component > > 		ComponentList
typedef std::list< Component * > ComponentPtrList
typedef std::list< Pointer
< Container > > 		ContainerList
typedef wxDC DeviceContext
typedef std::list< Pointer
< FloatingContainer > > 		FloatingContainerList
typedef wxFont Font
typedef wx::Menu Menu
typedef wx::Menu * MenuPtr
typedef std::map< WidgetID,
Panel * > 		PanelChildWidgets
 Keeps track of what Panel is associated with what WidgetID.
typedef int WidgetID
typedef wxWindow * WidgetPtr
typedef wxFrame * WindowPtr

Enumerations

enum  ALIGNMENT {
  NONE = 0, LEFT, RIGHT, TOP,
  BOTTOM, TAB, FLOATING, DOCKED
}
enum  BUTTON_TYPE { BTN_INVALID = 0, BTN_CLOSE, BTN_SELECTTAB }
enum  CHILD_ALIGNMENT { HORIZONTAL, VERTICAL, TABBED }
enum  MOUSE_FLAGS { ALT_DOWN = 0x1, SHIFT_DOWN = 0x2, CONTROL_DOWN = 0x4 }
enum  PANEL_FLAGS { PANEL_DEFAULT = 0, PANEL_NOT_CLOSEABLE }
enum  THEME_COLOR {
  THEME_COLOR_BACKGROUND = 1, THEME_COLOR_BORDER, THEME_COLOR_CAPTION_BACKGROUND, THEME_COLOR_CAPTION_TEXT,
  THEME_COLOR_INACTIVE_CAPTION_BG, THEME_COLOR_INACTIVE_CAPTION_TEXT, THEME_COLOR_TAB_AREA_BG, THEME_COLOR_ACTIVE_TAB_BG,
  THEME_COLOR_ACTIVE_TAB_TEXT, THEME_COLOR_INACTIVE_TAB_TEXT
}
 Declares IDs to use for accessing colors to use for rendering. More...
enum  THEME_FONT { THEME_FONT_CAPTION = 1, THEME_FONT_INACTIVE_TAB, THEME_FONT_ACTIVE_TAB }
 Declares IDs to use for accessing fonts to use for rendering. More...
enum  THEME_IMAGE {
  THEME_IMG_INVALID = 0, THEME_IMG_DOCK_UP, THEME_IMG_DOCK_UP_HI, THEME_IMG_DOCK_DOWN,
  THEME_IMG_DOCK_DOWN_HI, THEME_IMG_DOCK_LEFT, THEME_IMG_DOCK_LEFT_HI, THEME_IMG_DOCK_RIGHT,
  THEME_IMG_DOCK_RIGHT_HI, THEME_IMG_DOCK_TAB, THEME_IMG_DOCK_TAB_HI, THEME_IMG_BUTTON_CLOSE,
  THEME_IMG_BUTTON_CLOSE_HI, THEME_IMG_BUTTON_SELECTTAB, THEME_IMG_BUTTON_SELECTTAB_HI
}
 Declares IDs used to access images used when rendering. More...

Functions

template<typename T, typename U>
bool operator!= (T *lhs, const Pointer< U > &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< U > &rhs)
Size operator* (const Size &l, float f)
Point operator+ (const Point &l, const Point &r)
Size operator+ (const Size &l, const Size &r)
Point operator- (const Point &l, const Point &r)
Size operator- (const Size &l, const Size &r)
Size operator/ (const Size &l, float f)
template<typename T>
bool operator< (const Pointer< T > &lhs, const Pointer< T > &rhs)
template<typename T, typename U>
bool operator== (T *lhs, const Pointer< U > &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< U > &rhs)
template<typename U>
void swap (Pointer< U > &lhs, Pointer< U > &rhs)

Variables

const component_type ALL = -1
const int BUTTON_SPACE = 16
const component_type CONTAINER = 1
 The identifier for Containers.
const int ID_NONE = -1
const Color MASK_COLOR (0, 255, 255)
const component_type PANEL = 2
 The identifier for Panels.
const int SASH_SIZE = 4
const int SHOW_NA = 1
 Show a window but don't activate it.
const component_type TABBED_CONTAINER = 3
 The identifier for TabbedContainers.

Typedef Documentation

typedef wxBitmap ifm::Bitmap

typedef wxBitmap* ifm::BitmapPtr

typedef std::map<int, Color> ifm::ColorMap

typedef int ifm::component_type

Specifies a component type identifier.

typedef std::list< Pointer<Component> > ifm::ComponentList

typedef std::list<Component*> ifm::ComponentPtrList

typedef std::list< Pointer<Container> > ifm::ContainerList

typedef wxDC ifm::DeviceContext

typedef std::list< Pointer<FloatingContainer> > ifm::FloatingContainerList

typedef wxFont ifm::Font

typedef wx::Menu ifm::Menu

typedef wx::Menu* ifm::MenuPtr

typedef std::map<WidgetID, Panel*> ifm::PanelChildWidgets

Keeps track of what Panel is associated with what WidgetID.

typedef int ifm::WidgetID

typedef wxWindow* ifm::WidgetPtr

typedef wxFrame* ifm::WindowPtr

Enumeration Type Documentation

enum ifm::ALIGNMENT

Defines a common set of alignments (L, R, T ,B) as well as NONE, FLOATING, DOCKED, and TAB alignment. These alignments are used in various places, notably in docking to specify the relative alignment of a new child component, but also to specify the positioning of a container.

Enumerator:
NONE 
LEFT 
RIGHT 
TOP 
BOTTOM 
TAB 
FLOATING 
DOCKED 

enum ifm::BUTTON_TYPE

Enumerator:
BTN_INVALID 
BTN_CLOSE 
BTN_SELECTTAB 

enum ifm::CHILD_ALIGNMENT

These values specify containers align their children.

Enumerator:
HORIZONTAL 
VERTICAL 
TABBED 

enum ifm::MOUSE_FLAGS

Enumerator:
ALT_DOWN 
SHIFT_DOWN 
CONTROL_DOWN 

enum ifm::PANEL_FLAGS

Enumerator:
PANEL_DEFAULT 
PANEL_NOT_CLOSEABLE 

enum ifm::THEME_COLOR

Declares IDs to use for accessing colors to use for rendering.

Enumerator:
THEME_COLOR_BACKGROUND  Background color.
THEME_COLOR_BORDER  Border color.
THEME_COLOR_CAPTION_BACKGROUND  Active caption background color.
THEME_COLOR_CAPTION_TEXT  Active caption text color.
THEME_COLOR_INACTIVE_CAPTION_BG  Inactive caption background color.
THEME_COLOR_INACTIVE_CAPTION_TEXT  Inactive caption text color.
THEME_COLOR_TAB_AREA_BG  Background color for area where tabs appear.
THEME_COLOR_ACTIVE_TAB_BG  Background color for active tabs.
THEME_COLOR_ACTIVE_TAB_TEXT  Text color for active tabs.
THEME_COLOR_INACTIVE_TAB_TEXT  Text color for inactive tabs.

enum ifm::THEME_FONT

Declares IDs to use for accessing fonts to use for rendering.

Enumerator:
THEME_FONT_CAPTION  Caption font.
THEME_FONT_INACTIVE_TAB  Font for inactive tabs.
THEME_FONT_ACTIVE_TAB  Font for active tabs.

enum ifm::THEME_IMAGE

Declares IDs used to access images used when rendering.

Enumerator:
THEME_IMG_INVALID 
THEME_IMG_DOCK_UP 
THEME_IMG_DOCK_UP_HI 
THEME_IMG_DOCK_DOWN 
THEME_IMG_DOCK_DOWN_HI 
THEME_IMG_DOCK_LEFT 
THEME_IMG_DOCK_LEFT_HI 
THEME_IMG_DOCK_RIGHT 
THEME_IMG_DOCK_RIGHT_HI 
THEME_IMG_DOCK_TAB 
THEME_IMG_DOCK_TAB_HI 
THEME_IMG_BUTTON_CLOSE 
THEME_IMG_BUTTON_CLOSE_HI 
THEME_IMG_BUTTON_SELECTTAB 
THEME_IMG_BUTTON_SELECTTAB_HI 

Function Documentation

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

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

template<typename T, typename U>
bool ifm::operator!= ( const Pointer< T > &  lhs,
const Pointer< U > &  rhs 
)

Size ifm::operator* ( const Size &  l,
float  f 
)

Point ifm::operator+ ( const Point &  l,
const Point &  r 
)

Size ifm::operator+ ( const Size &  l,
const Size &  r 
)

Point ifm::operator- ( const Point &  l,
const Point &  r 
)

Size ifm::operator- ( const Size &  l,
const Size &  r 
)

Size ifm::operator/ ( const Size &  l,
float  f 
)

template<typename T>
bool ifm::operator< ( const Pointer< T > &  lhs,
const Pointer< T > &  rhs 
)

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

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

template<typename T, typename U>
bool ifm::operator== ( const Pointer< T > &  lhs,
const Pointer< U > &  rhs 
)

template<typename U>
void ifm::swap ( Pointer< U > &  lhs,
Pointer< U > &  rhs 
)

Variable Documentation

const component_type ifm::ALL = -1

const int ifm::BUTTON_SPACE = 16

const component_type ifm::CONTAINER = 1

The identifier for Containers.

const int ifm::ID_NONE = -1

This ID value means the component has no ID, will be destroyed if it has no children, and you cannot add new children to it at run time by giving an ID value.

const Color ifm::MASK_COLOR(0, 255, 255)

const component_type ifm::PANEL = 2

The identifier for Panels.

const int ifm::SASH_SIZE = 4

const int ifm::SHOW_NA = 1

Show a window but don't activate it.

const component_type ifm::TABBED_CONTAINER = 3

The identifier for TabbedContainers.

doxygen Get IFM - Interface Management System at SourceForge.net. Fast, secure and Free Open Source software downloads