GG Namespace Reference

The namespace that encloses all GG classes, functions, typedefs, enums, etc. More...


Classes

class  BrowseInfoWnd
 The abstract base class for all browse-info display windows. More...
class  TextBoxBrowseInfoWnd
 A subclass of BrowseInfoWnd that displays text in a box, optionally with a border. More...
class  Button
 This is a basic button control. More...
class  StateButton
 This is a basic state button control. More...
class  RadioButtonGroup
 This is a class that encapsulates multiple GG::StateButtons into a single radio-button control. More...
struct  Clr
 A simple 32-bit structure that can act as a packed 32-bit unsigned integer representation of a RGBA color, a vector of the four unsigned bytes that compose an RGBA color, or the individual unsigned bytes "a", "r", "g", and "b", each of which represents a color channel. More...
class  Control
 This is an abstract base class for all control classes. More...
class  Cursor
 Cursor is the base class for GUI-renderable cursors. More...
class  TextureCursor
 TextureCursor is a very simple subclass of Cursor. More...
struct  HSVClr
 contains the necessary data to represent a color in HSV space, with an alpha value thrown in to make conversions to and from GG::Clr possible. More...
class  HueSaturationPicker
 a control specifically designed for ColorDlg that allows the user to select a point in the Hue-Saturation subspace of the HSV color space. More...
class  ValuePicker
 a control specifically designed for ColorDlg that allows the user to select a point in the Value subspace of the HSV color space. More...
class  ColorDlg
 a dialog box used to get a color selection from the user. More...
class  FileDlg
 the default file open/save dialog box. More...
class  ThreeButtonDlg
 a general pop-up message or user input box with one, two, or three buttons. More...
class  DropDownList
 displays a single choice, and allows the user to select items from a pop-up list. More...
class  DynamicGraphic
 a control that replays images in sequence, forwards or backwards, animated or one frame at a time. More...
class  Edit
 This is a single-line text input control. More...
struct  EnumMapBase
 A base type for all templated EnumMap types. More...
struct  EnumMap
 A mapping between the values of an enum and the string representations of the enum's values. More...
struct  EventPumpState
 encapsulates the state of GG event pumping. More...
class  EventPumpBase
 the base type for all EventPump types. More...
class  EventPump
 encapsulates the GG event-pumping mechanism. More...
class  ModalEventPump
 an EventPump that terminates when the bool reference done supplied to the constructor is true. More...
class  ExceptionBase
 This is the base class for all GG exceptions. More...
struct  is_flag_type
 Metafunction predicate that evaluates as true iff T is a GG flag type, declared by using GG_FLAG_TYPE. More...
class  FlagSpec
 A singleton that encapsulates the set of known flags of type FlagType. More...
class  Flags
 A set of flags of the same type. More...
class  Font
 This class creates one or more 16-bpp OpenGL textures that contain rendered text from a requested font file at the requested point size, including only the requested ranges of characters. More...
class  FontManager
 This singleton class is essentially a very thin wrapper around a map of Font smart pointers, keyed on font filename/point size pairs. More...
class  GUI
 An abstract base for an GUI framework class to drive the GG GUI. More...
class  Layout
 an invisible Wnd subclass whose only purpose is to arrange its child Wnds. More...
class  ListBox
 a flexible control that can contain rows and columns of other controls, even other ListBoxes. More...
struct  MenuItem
 serves as a single menu entry in a GG::MenuBar or GG::PopupMenu; may include a submenu. More...
class  MenuBar
 a menu bar control providing "browse" updates to user navigation of the menu. More...
class  PopupMenu
 this is a modal pop-up menu. More...
class  MultiEdit
 This is a multi-line text input and display control. More...
class  OgreGUI
 This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application. More...
class  PluginInterface
 the interface to custom-control plugins. More...
class  PluginManager
 this singleton class is essentially a very thin wrapper around a map of PluginInterface smart pointers, keyed on std::string plugin names. More...
struct  Pt
 a GG screen coordinate class More...
struct  Rect
 a GG rectangle class. More...
class  Scroll
 This is a basic scrollbar control. More...
class  SDLGUI
 This is an abstract singleton class that represents the GUI framework of an SDL OpenGL application. More...
class  Slider
 a slider control. More...
class  Spin
 a spin box control. More...
class  StaticGraphic
 This is a simple, non-interactive window that displays a GG::SubTexture. More...
class  StyleFactory
 Creates new dialogs and Controls. More...
class  TabWnd
 Contains several Wnds and a TabBar, and only displays the Wnd currently selected in the TabBar. More...
class  TabBar
 Contains a sequence of buttons (hereafter "tabs") that act together in a RadioButtonGroup. More...
class  TextControl
 The name says it all. More...
class  Texture
 This class encapsulates OpenGL texture objects. More...
class  SubTexture
 This class is a convenient way to store the info needed to use a portion of an OpenGL texture. More...
class  TextureManager
 This singleton class is essentially a very thin wrapper around a map of Texture smart pointers, keyed on std::string texture names. More...
class  Timer
 Timer provides a means for one or more Wnds to receive periodic notifications of the passage of time. More...
class  Wnd
 This is the basic GG window class. More...
class  WndEvent
 encapsulates a Wnd event that is passed from the singleton GUI to a Wnd. More...
class  ZList
 a Z-ordering (depth-ordering) of the windows in the GUI. More...
class  OgreGUIInputPlugin
 The base class for Ogre plugins that provides input functionality to OgreGUI. More...

Enumerations

enum  WndRegion {
  WR_NONE = -1,
  WR_TOPLEFT = 0,
  WR_TOP,
  WR_TOPRIGHT,
  WR_MIDLEFT,
  WR_MIDDLE,
  WR_MIDRIGHT,
  WR_BOTTOMLEFT,
  WR_BOTTOM,
  WR_BOTTOMRIGHT
}
enum  Orientation {
  VERTICAL,
  HORIZONTAL
}
enum  StateButtonStyle {
  SBSTYLE_3D_XBOX,
  SBSTYLE_3D_CHECKBOX,
  SBSTYLE_3D_RADIO,
  SBSTYLE_3D_BUTTON,
  SBSTYLE_3D_ROUND_BUTTON,
  SBSTYLE_3D_TOP_ATTACHED_TAB,
  SBSTYLE_3D_TOP_DETACHED_TAB
}
enum  SliderLineStyle {
  FLAT,
  RAISED,
  GROOVED
}
enum  TabBarStyle {
  TAB_BAR_ATTACHED,
  TAB_BAR_DETACHED
}
enum  Key {
  GGK_UNKNOWN = 0,
  GGK_FIRST = 0,
  GGK_BACKSPACE = 8,
  GGK_TAB = 9,
  GGK_CLEAR = 12,
  GGK_RETURN = 13,
  GGK_PAUSE = 19,
  GGK_ESCAPE = 27,
  GGK_SPACE = 32,
  GGK_EXCLAIM = 33,
  GGK_QUOTEDBL = 34,
  GGK_HASH = 35,
  GGK_DOLLAR = 36,
  GGK_AMPERSAND = 38,
  GGK_QUOTE = 39,
  GGK_LEFTPAREN = 40,
  GGK_RIGHTPAREN = 41,
  GGK_ASTERISK = 42,
  GGK_PLUS = 43,
  GGK_COMMA = 44,
  GGK_MINUS = 45,
  GGK_PERIOD = 46,
  GGK_SLASH = 47,
  GGK_0 = 48,
  GGK_1 = 49,
  GGK_2 = 50,
  GGK_3 = 51,
  GGK_4 = 52,
  GGK_5 = 53,
  GGK_6 = 54,
  GGK_7 = 55,
  GGK_8 = 56,
  GGK_9 = 57,
  GGK_COLON = 58,
  GGK_SEMICOLON = 59,
  GGK_LESS = 60,
  GGK_EQUALS = 61,
  GGK_GREATER = 62,
  GGK_QUESTION = 63,
  GGK_AT = 64,
  GGK_A = 65,
  GGK_B = 66,
  GGK_C = 67,
  GGK_D = 68,
  GGK_E = 69,
  GGK_F = 70,
  GGK_G = 71,
  GGK_H = 72,
  GGK_I = 73,
  GGK_J = 74,
  GGK_K = 75,
  GGK_L = 76,
  GGK_M = 77,
  GGK_N = 78,
  GGK_O = 79,
  GGK_P = 80,
  GGK_Q = 81,
  GGK_R = 82,
  GGK_S = 83,
  GGK_T = 84,
  GGK_U = 85,
  GGK_V = 86,
  GGK_W = 87,
  GGK_X = 88,
  GGK_Y = 89,
  GGK_Z = 90,
  GGK_LEFTBRACKET = 91,
  GGK_BACKSLASH = 92,
  GGK_RIGHTBRACKET = 93,
  GGK_CARET = 94,
  GGK_UNDERSCORE = 95,
  GGK_BACKQUOTE = 96,
  GGK_a = 97,
  GGK_b = 98,
  GGK_c = 99,
  GGK_d = 100,
  GGK_e = 101,
  GGK_f = 102,
  GGK_g = 103,
  GGK_h = 104,
  GGK_i = 105,
  GGK_j = 106,
  GGK_k = 107,
  GGK_l = 108,
  GGK_m = 109,
  GGK_n = 110,
  GGK_o = 111,
  GGK_p = 112,
  GGK_q = 113,
  GGK_r = 114,
  GGK_s = 115,
  GGK_t = 116,
  GGK_u = 117,
  GGK_v = 118,
  GGK_w = 119,
  GGK_x = 120,
  GGK_y = 121,
  GGK_z = 122,
  GGK_DELETE = 127,
  GGK_WORLD_0 = 160,
  GGK_WORLD_1 = 161,
  GGK_WORLD_2 = 162,
  GGK_WORLD_3 = 163,
  GGK_WORLD_4 = 164,
  GGK_WORLD_5 = 165,
  GGK_WORLD_6 = 166,
  GGK_WORLD_7 = 167,
  GGK_WORLD_8 = 168,
  GGK_WORLD_9 = 169,
  GGK_WORLD_10 = 170,
  GGK_WORLD_11 = 171,
  GGK_WORLD_12 = 172,
  GGK_WORLD_13 = 173,
  GGK_WORLD_14 = 174,
  GGK_WORLD_15 = 175,
  GGK_WORLD_16 = 176,
  GGK_WORLD_17 = 177,
  GGK_WORLD_18 = 178,
  GGK_WORLD_19 = 179,
  GGK_WORLD_20 = 180,
  GGK_WORLD_21 = 181,
  GGK_WORLD_22 = 182,
  GGK_WORLD_23 = 183,
  GGK_WORLD_24 = 184,
  GGK_WORLD_25 = 185,
  GGK_WORLD_26 = 186,
  GGK_WORLD_27 = 187,
  GGK_WORLD_28 = 188,
  GGK_WORLD_29 = 189,
  GGK_WORLD_30 = 190,
  GGK_WORLD_31 = 191,
  GGK_WORLD_32 = 192,
  GGK_WORLD_33 = 193,
  GGK_WORLD_34 = 194,
  GGK_WORLD_35 = 195,
  GGK_WORLD_36 = 196,
  GGK_WORLD_37 = 197,
  GGK_WORLD_38 = 198,
  GGK_WORLD_39 = 199,
  GGK_WORLD_40 = 200,
  GGK_WORLD_41 = 201,
  GGK_WORLD_42 = 202,
  GGK_WORLD_43 = 203,
  GGK_WORLD_44 = 204,
  GGK_WORLD_45 = 205,
  GGK_WORLD_46 = 206,
  GGK_WORLD_47 = 207,
  GGK_WORLD_48 = 208,
  GGK_WORLD_49 = 209,
  GGK_WORLD_50 = 210,
  GGK_WORLD_51 = 211,
  GGK_WORLD_52 = 212,
  GGK_WORLD_53 = 213,
  GGK_WORLD_54 = 214,
  GGK_WORLD_55 = 215,
  GGK_WORLD_56 = 216,
  GGK_WORLD_57 = 217,
  GGK_WORLD_58 = 218,
  GGK_WORLD_59 = 219,
  GGK_WORLD_60 = 220,
  GGK_WORLD_61 = 221,
  GGK_WORLD_62 = 222,
  GGK_WORLD_63 = 223,
  GGK_WORLD_64 = 224,
  GGK_WORLD_65 = 225,
  GGK_WORLD_66 = 226,
  GGK_WORLD_67 = 227,
  GGK_WORLD_68 = 228,
  GGK_WORLD_69 = 229,
  GGK_WORLD_70 = 230,
  GGK_WORLD_71 = 231,
  GGK_WORLD_72 = 232,
  GGK_WORLD_73 = 233,
  GGK_WORLD_74 = 234,
  GGK_WORLD_75 = 235,
  GGK_WORLD_76 = 236,
  GGK_WORLD_77 = 237,
  GGK_WORLD_78 = 238,
  GGK_WORLD_79 = 239,
  GGK_WORLD_80 = 240,
  GGK_WORLD_81 = 241,
  GGK_WORLD_82 = 242,
  GGK_WORLD_83 = 243,
  GGK_WORLD_84 = 244,
  GGK_WORLD_85 = 245,
  GGK_WORLD_86 = 246,
  GGK_WORLD_87 = 247,
  GGK_WORLD_88 = 248,
  GGK_WORLD_89 = 249,
  GGK_WORLD_90 = 250,
  GGK_WORLD_91 = 251,
  GGK_WORLD_92 = 252,
  GGK_WORLD_93 = 253,
  GGK_WORLD_94 = 254,
  GGK_WORLD_95 = 255,
  GGK_KP0 = 256,
  GGK_KP1 = 257,
  GGK_KP2 = 258,
  GGK_KP3 = 259,
  GGK_KP4 = 260,
  GGK_KP5 = 261,
  GGK_KP6 = 262,
  GGK_KP7 = 263,
  GGK_KP8 = 264,
  GGK_KP9 = 265,
  GGK_KP_PERIOD = 266,
  GGK_KP_DIVIDE = 267,
  GGK_KP_MULTIPLY = 268,
  GGK_KP_MINUS = 269,
  GGK_KP_PLUS = 270,
  GGK_KP_ENTER = 271,
  GGK_KP_EQUALS = 272,
  GGK_UP = 273,
  GGK_DOWN = 274,
  GGK_RIGHT = 275,
  GGK_LEFT = 276,
  GGK_INSERT = 277,
  GGK_HOME = 278,
  GGK_END = 279,
  GGK_PAGEUP = 280,
  GGK_PAGEDOWN = 281,
  GGK_F1 = 282,
  GGK_F2 = 283,
  GGK_F3 = 284,
  GGK_F4 = 285,
  GGK_F5 = 286,
  GGK_F6 = 287,
  GGK_F7 = 288,
  GGK_F8 = 289,
  GGK_F9 = 290,
  GGK_F10 = 291,
  GGK_F11 = 292,
  GGK_F12 = 293,
  GGK_F13 = 294,
  GGK_F14 = 295,
  GGK_F15 = 296,
  GGK_NUMLOCK = 300,
  GGK_CAPSLOCK = 301,
  GGK_SCROLLOCK = 302,
  GGK_RSHIFT = 303,
  GGK_LSHIFT = 304,
  GGK_RCTRL = 305,
  GGK_LCTRL = 306,
  GGK_RALT = 307,
  GGK_LALT = 308,
  GGK_RMETA = 309,
  GGK_LMETA = 310,
  GGK_LSUPER = 311,
  GGK_RSUPER = 312,
  GGK_MODE = 313,
  GGK_COMPOSE = 314,
  GGK_HELP = 315,
  GGK_PRINT = 316,
  GGK_SYSREQ = 317,
  GGK_BREAK = 318,
  GGK_MENU = 319,
  GGK_POWER = 320,
  GGK_EURO = 321,
  GGK_UNDO = 322,
  GGK_LAST
}

Functions

 GG_FLAG_TYPE (Alignment)
void KeypadKeyToPrintable (Key &key, Flags< ModKey > mod_keys)
GG_API Clr FloatClr (float r_, float g_, float b_, float a_)
GG_API bool operator== (const Clr &rhs, const Clr &lhs)
GG_API bool operator!= (const Clr &rhs, const Clr &lhs)
GG_API void glColor (Clr clr)
GG_API Clr LightColor (Clr clr)
GG_API Clr DarkColor (Clr clr)
GG_API Clr DisabledColor (Clr clr)
GG_API void BeginScissorClipping (Pt ul, Pt lr)
GG_API void BeginScissorClipping (int x1, int y1, int x2, int y2)
GG_API void EndScissorClipping ()
GG_API void FlatRectangle (int x1, int y1, int x2, int y2, Clr color, Clr border_color, int border_thick=2)
GG_API void BeveledRectangle (int x1, int y1, int x2, int y2, Clr color, Clr border_color, bool up, int bevel_thick=2, bool bevel_left=true, bool bevel_top=true, bool bevel_right=true, bool bevel_bottom=true)
GG_API void FlatCheck (int x1, int y1, int x2, int y2, Clr color)
GG_API void BeveledCheck (int x1, int y1, int x2, int y2, Clr color)
GG_API void FlatX (int x1, int y1, int x2, int y2, Clr color)
GG_API void BeveledX (int x1, int y1, int x2, int y2, Clr color)
GG_API void Bubble (int x1, int y1, int x2, int y2, Clr color, bool up=true)
GG_API void FlatCircle (int x1, int y1, int x2, int y2, Clr color, Clr border_color, int thick=2)
GG_API void BeveledCircle (int x1, int y1, int x2, int y2, Clr color, Clr border_color, bool up=true, int bevel_thick=2)
GG_API void FlatRoundedRectangle (int x1, int y1, int x2, int y2, Clr color, Clr border_color, int corner_radius=5, int border_thick=2)
GG_API void BeveledRoundedRectangle (int x1, int y1, int x2, int y2, Clr color, Clr border_color, bool up, int corner_radius=5, int bevel_thick=2)
GG_API void BubbleRectangle (int x1, int y1, int x2, int y2, Clr color, bool up, int corner_radius=5)
template<class E>
EnumMap< E > GetEnumMap ()
template<class FlagType>
std::ostream & operator<< (std::ostream &os, Flags< FlagType > flags)
template<class FlagType>
Flags< FlagType > operator| (Flags< FlagType > lhs, Flags< FlagType > rhs)
template<class FlagType>
Flags< FlagType > operator| (Flags< FlagType > lhs, FlagType rhs)
template<class FlagType>
Flags< FlagType > operator| (FlagType lhs, Flags< FlagType > rhs)
template<class FlagType>
boost::enable_if< is_flag_type<
FlagType >, Flags< FlagType
>>::type 		operator| (FlagType lhs, FlagType rhs)
template<class FlagType>
Flags< FlagType > operator & (Flags< FlagType > lhs, Flags< FlagType > rhs)
template<class FlagType>
Flags< FlagType > operator & (Flags< FlagType > lhs, FlagType rhs)
template<class FlagType>
Flags< FlagType > operator & (FlagType lhs, Flags< FlagType > rhs)
template<class FlagType>
boost::enable_if< is_flag_type<
FlagType >, Flags< FlagType
>>::type 		operator & (FlagType lhs, FlagType rhs)
template<class FlagType>
Flags< FlagType > operator^ (Flags< FlagType > lhs, Flags< FlagType > rhs)
template<class FlagType>
Flags< FlagType > operator^ (Flags< FlagType > lhs, FlagType rhs)
template<class FlagType>
Flags< FlagType > operator^ (FlagType lhs, Flags< FlagType > rhs)
template<class FlagType>
boost::enable_if< is_flag_type<
FlagType >, Flags< FlagType
>>::type 		operator^ (FlagType lhs, FlagType rhs)
template<class FlagType>
Flags< FlagType > operator~ (Flags< FlagType > flags)
template<class FlagType>
boost::enable_if< is_flag_type<
FlagType >, Flags< FlagType
>>::type 		operator~ (FlagType flag)
GG_API std::string RgbaTag (const Clr &c)
 GG_FLAG_TYPE (TextFormat)
FontManager & GetFontManager ()
 GG_EXCEPTION (FailedFTLibraryInit)
GG_API bool MatchesOrContains (const Wnd *lwnd, const Wnd *rwnd)
 GG_FLAG_TYPE (ListBoxStyle)
 GG_FLAG_TYPE (MultiEditStyle)
GG_API PluginManager & GetPluginManager ()
GG_API bool operator== (const Pt &lhs, const Pt &rhs)
GG_API bool operator!= (const Pt &lhs, const Pt &rhs)
GG_API bool operator< (const Pt &lhs, const Pt &rhs)
GG_API bool operator> (const Pt &lhs, const Pt &rhs)
GG_API bool operator<= (const Pt &lhs, const Pt &rhs)
GG_API bool operator>= (const Pt &lhs, const Pt &rhs)
GG_API Pt operator+ (const Pt &lhs, const Pt &rhs)
GG_API Pt operator- (const Pt &lhs, const Pt &rhs)
GG_API std::ostream & operator<< (std::ostream &os, const Pt &pt)
GG_API bool operator== (const Rect &lhs, const Rect &rhs)
GG_API bool operator!= (const Rect &lhs, const Rect &rhs)
GG_API Rect operator+ (const Rect &rect, const Pt &pt)
GG_API Rect operator- (const Rect &rect, const Pt &pt)
GG_API Rect operator+ (const Pt &pt, const Rect &rect)
GG_API Rect operator- (const Pt &pt, const Rect &rect)
GG_API std::ostream & operator<< (std::ostream &os, const Rect &rect)
template<class SigT>
boost::signals::connection Connect (SigT &sig, const typename SigT::slot_type &_slot, boost::signals::connect_position at=boost::signals::at_back)
template<class SigT>
boost::signals::connection Connect (SigT &sig, const typename SigT::slot_type &_slot, int grp, boost::signals::connect_position at=boost::signals::at_back)
template<class C, class R, class T1, class T2 GG_SIGNALS_SIGNAL_TEMPLATE_PARMS>
boost::signals::connection Connect (boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &sig, R(T1::*fn)(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), T2 obj, boost::signals::connect_position at=boost::signals::at_back)
template<class C, class R, class T1, class T2 GG_SIGNALS_SIGNAL_TEMPLATE_PARMS>
boost::signals::connection Connect (boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &sig, R(T1::*fn)(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), T2 obj, int grp, boost::signals::connect_position at=boost::signals::at_back)
template<class C, class R GG_SIGNALS_SIGNAL_TEMPLATE_PARMS>
boost::signals::connection Connect (boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &sig1, boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &sig2, boost::signals::connect_position at=boost::signals::at_back)
template<class C, class R GG_SIGNALS_SIGNAL_TEMPLATE_PARMS>
boost::signals::connection Connect (boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &sig1, boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &sig2, int grp, boost::signals::connect_position at=boost::signals::at_back)
 GG_FLAG_TYPE (GraphicStyle)
TextureManager & GetTextureManager ()
 GG_FLAG_TYPE (WndFlag)

Variables

GG_API const Alignment ALIGN_NONE
GG_API const Alignment ALIGN_VCENTER
GG_API const Alignment ALIGN_TOP
GG_API const Alignment ALIGN_BOTTOM
GG_API const Alignment ALIGN_CENTER
GG_API const Alignment ALIGN_LEFT
GG_API const Alignment ALIGN_RIGHT
GG_API const TextFormat FORMAT_NONE
GG_API const TextFormat FORMAT_VCENTER
GG_API const TextFormat FORMAT_TOP
GG_API const TextFormat FORMAT_BOTTOM
GG_API const TextFormat FORMAT_CENTER
GG_API const TextFormat FORMAT_LEFT
GG_API const TextFormat FORMAT_RIGHT
GG_API const TextFormat FORMAT_WORDBREAK
GG_API const TextFormat FORMAT_LINEWRAP
GG_API const TextFormat FORMAT_IGNORETAGS
GG_API const ListBoxStyle LIST_NONE
GG_API const ListBoxStyle LIST_VCENTER
GG_API const ListBoxStyle LIST_TOP
GG_API const ListBoxStyle LIST_BOTTOM
GG_API const ListBoxStyle LIST_CENTER
GG_API const ListBoxStyle LIST_LEFT
GG_API const ListBoxStyle LIST_RIGHT
GG_API const ListBoxStyle LIST_NOSORT
GG_API const ListBoxStyle LIST_SORTDESCENDING
GG_API const ListBoxStyle LIST_NOSEL
GG_API const ListBoxStyle LIST_SINGLESEL
GG_API const ListBoxStyle LIST_QUICKSEL
GG_API const ListBoxStyle LIST_USERDELETE
GG_API const ListBoxStyle LIST_BROWSEUPDATES
GG_API const MultiEditStyle MULTI_NONE
GG_API const MultiEditStyle MULTI_WORDBREAK
GG_API const MultiEditStyle MULTI_LINEWRAP
GG_API const MultiEditStyle MULTI_VCENTER
GG_API const MultiEditStyle MULTI_TOP
GG_API const MultiEditStyle MULTI_BOTTOM
GG_API const MultiEditStyle MULTI_CENTER
GG_API const MultiEditStyle MULTI_LEFT
GG_API const MultiEditStyle MULTI_RIGHT
GG_API const MultiEditStyle MULTI_READ_ONLY
GG_API const MultiEditStyle MULTI_TERMINAL_STYLE
GG_API const MultiEditStyle MULTI_INTEGRAL_HEIGHT
GG_API const MultiEditStyle MULTI_NO_VSCROLL
GG_API const MultiEditStyle MULTI_NO_HSCROLL
GG_API const Flags< MultiEditStyle > MULTI_NO_SCROLL
GG_API const GraphicStyle GRAPHIC_NONE
GG_API const GraphicStyle GRAPHIC_VCENTER
GG_API const GraphicStyle GRAPHIC_TOP
GG_API const GraphicStyle GRAPHIC_BOTTOM
GG_API const GraphicStyle GRAPHIC_CENTER
GG_API const GraphicStyle GRAPHIC_LEFT
GG_API const GraphicStyle GRAPHIC_RIGHT
GG_API const GraphicStyle GRAPHIC_FITGRAPHIC
GG_API const GraphicStyle GRAPHIC_SHRINKFIT
GG_API const GraphicStyle GRAPHIC_PROPSCALE
GG_API const WndFlag CLICKABLE
GG_API const WndFlag REPEAT_BUTTON_DOWN
GG_API const WndFlag DRAGABLE
GG_API const WndFlag RESIZABLE
GG_API const WndFlag ONTOP
GG_API const WndFlag MODAL
GG_API const ModKey MOD_KEY_NONE
GG_API const ModKey MOD_KEY_LSHIFT
GG_API const ModKey MOD_KEY_RSHIFT
GG_API const ModKey MOD_KEY_LCTRL
GG_API const ModKey MOD_KEY_RCTRL
GG_API const ModKey MOD_KEY_LALT
GG_API const ModKey MOD_KEY_RALT
GG_API const ModKey MOD_KEY_LMETA
GG_API const ModKey MOD_KEY_RMETA
GG_API const ModKey MOD_KEY_NUM
GG_API const ModKey MOD_KEY_CAPS
GG_API const ModKey MOD_KEY_MODE
GG_API const Flags< ModKey > MOD_KEY_CTRL
GG_API const Flags< ModKey > MOD_KEY_SHIFT
GG_API const Flags< ModKey > MOD_KEY_ALT
GG_API const Flags< ModKey > MOD_KEY_META

Detailed Description

The namespace that encloses all GG classes, functions, typedefs, enums, etc.

Enumeration Type Documentation

enum GG::WndRegion

"Regions" of a window; used eg to determine direction(s) of drag when a window that has a drag-frame is clicked

Enumerator:
WR_NONE 
WR_TOPLEFT 
WR_TOP 
WR_TOPRIGHT 
WR_MIDLEFT 
WR_MIDDLE 
WR_MIDRIGHT 
WR_BOTTOMLEFT 
WR_BOTTOM 
WR_BOTTOMRIGHT 

Definition at line 75 of file Base.h.

enum GG::Orientation

The orientations for scrollbars, sliders, etc.

Enumerator:
VERTICAL 
HORIZONTAL 

Definition at line 89 of file Base.h.

enum GG::StateButtonStyle

The built-in visual styles of state buttons.

Enumerator:
SBSTYLE_3D_XBOX  draws a down-beveled box with a 3D x-mark inside
SBSTYLE_3D_CHECKBOX  draws a down-beveled box with a 3D check-mark inside
SBSTYLE_3D_RADIO  draws a down-beveled circle with a 3D "dot" or "bubble" inside
SBSTYLE_3D_BUTTON  draws a button that toggles bewtween popped up and pushed down
SBSTYLE_3D_ROUND_BUTTON  draws a down-beveled circle with an up-beveled circle inside
SBSTYLE_3D_TOP_ATTACHED_TAB  draws an up-beveled rectagular tab that is brighter and larger when pressed; it's bottom is unbeveled
SBSTYLE_3D_TOP_DETACHED_TAB  draws an up-beveled rectagular tab that is brighter and larger when pressed; it's bottom is beveled

Definition at line 95 of file Base.h.

enum GG::SliderLineStyle

The rendering styles of the line the tab slides over in a Slider.

Enumerator:
FLAT 
RAISED 
GROOVED 

Definition at line 106 of file Base.h.

enum GG::TabBarStyle

The styles of display for a TabBar.

Enumerator:
TAB_BAR_ATTACHED  The currently active tab should appear to be connected to the area below the bar.
TAB_BAR_DETACHED  The currently active tab should appear to be unconnected to the area below the bar.

Definition at line 113 of file Base.h.

enum GG::Key

adpated from SDLKey enum in SDL_keysym.h of the SDL library; capital letter keys added

Enumerator:
GGK_UNKNOWN 
GGK_FIRST 
GGK_BACKSPACE 
GGK_TAB 
GGK_CLEAR 
GGK_RETURN 
GGK_PAUSE 
GGK_ESCAPE 
GGK_SPACE 
GGK_EXCLAIM 
GGK_QUOTEDBL 
GGK_HASH 
GGK_DOLLAR 
GGK_AMPERSAND 
GGK_QUOTE 
GGK_LEFTPAREN 
GGK_RIGHTPAREN 
GGK_ASTERISK 
GGK_PLUS 
GGK_COMMA 
GGK_MINUS 
GGK_PERIOD 
GGK_SLASH 
GGK_0 
GGK_1 
GGK_2 
GGK_3 
GGK_4 
GGK_5 
GGK_6 
GGK_7 
GGK_8 
GGK_9 
GGK_COLON 
GGK_SEMICOLON 
GGK_LESS 
GGK_EQUALS 
GGK_GREATER 
GGK_QUESTION 
GGK_AT 
GGK_A 
GGK_B 
GGK_C 
GGK_D 
GGK_E 
GGK_F 
GGK_G 
GGK_H 
GGK_I 
GGK_J 
GGK_K 
GGK_L 
GGK_M 
GGK_N 
GGK_O 
GGK_P 
GGK_Q 
GGK_R 
GGK_S 
GGK_T 
GGK_U 
GGK_V 
GGK_W 
GGK_X 
GGK_Y 
GGK_Z 
GGK_LEFTBRACKET 
GGK_BACKSLASH 
GGK_RIGHTBRACKET 
GGK_CARET 
GGK_UNDERSCORE 
GGK_BACKQUOTE 
GGK_a 
GGK_b 
GGK_c 
GGK_d 
GGK_e 
GGK_f 
GGK_g 
GGK_h 
GGK_i 
GGK_j 
GGK_k 
GGK_l 
GGK_m 
GGK_n 
GGK_o 
GGK_p 
GGK_q 
GGK_r 
GGK_s 
GGK_t 
GGK_u 
GGK_v 
GGK_w 
GGK_x 
GGK_y 
GGK_z 
GGK_DELETE 
GGK_WORLD_0  0xA0
GGK_WORLD_1 
GGK_WORLD_2 
GGK_WORLD_3 
GGK_WORLD_4 
GGK_WORLD_5 
GGK_WORLD_6 
GGK_WORLD_7 
GGK_WORLD_8 
GGK_WORLD_9 
GGK_WORLD_10 
GGK_WORLD_11 
GGK_WORLD_12 
GGK_WORLD_13 
GGK_WORLD_14 
GGK_WORLD_15 
GGK_WORLD_16 
GGK_WORLD_17 
GGK_WORLD_18 
GGK_WORLD_19 
GGK_WORLD_20 
GGK_WORLD_21 
GGK_WORLD_22 
GGK_WORLD_23 
GGK_WORLD_24 
GGK_WORLD_25 
GGK_WORLD_26 
GGK_WORLD_27 
GGK_WORLD_28 
GGK_WORLD_29 
GGK_WORLD_30 
GGK_WORLD_31 
GGK_WORLD_32 
GGK_WORLD_33 
GGK_WORLD_34 
GGK_WORLD_35 
GGK_WORLD_36 
GGK_WORLD_37 
GGK_WORLD_38 
GGK_WORLD_39 
GGK_WORLD_40 
GGK_WORLD_41 
GGK_WORLD_42 
GGK_WORLD_43 
GGK_WORLD_44 
GGK_WORLD_45 
GGK_WORLD_46 
GGK_WORLD_47 
GGK_WORLD_48 
GGK_WORLD_49 
GGK_WORLD_50 
GGK_WORLD_51 
GGK_WORLD_52 
GGK_WORLD_53 
GGK_WORLD_54 
GGK_WORLD_55 
GGK_WORLD_56 
GGK_WORLD_57 
GGK_WORLD_58 
GGK_WORLD_59 
GGK_WORLD_60 
GGK_WORLD_61 
GGK_WORLD_62 
GGK_WORLD_63 
GGK_WORLD_64 
GGK_WORLD_65 
GGK_WORLD_66 
GGK_WORLD_67 
GGK_WORLD_68 
GGK_WORLD_69 
GGK_WORLD_70 
GGK_WORLD_71 
GGK_WORLD_72 
GGK_WORLD_73 
GGK_WORLD_74 
GGK_WORLD_75 
GGK_WORLD_76 
GGK_WORLD_77 
GGK_WORLD_78 
GGK_WORLD_79 
GGK_WORLD_80 
GGK_WORLD_81 
GGK_WORLD_82 
GGK_WORLD_83 
GGK_WORLD_84 
GGK_WORLD_85 
GGK_WORLD_86 
GGK_WORLD_87 
GGK_WORLD_88 
GGK_WORLD_89 
GGK_WORLD_90 
GGK_WORLD_91 
GGK_WORLD_92 
GGK_WORLD_93 
GGK_WORLD_94 
GGK_WORLD_95  0xFF
GGK_KP0 
GGK_KP1 
GGK_KP2 
GGK_KP3 
GGK_KP4 
GGK_KP5 
GGK_KP6 
GGK_KP7 
GGK_KP8 
GGK_KP9 
GGK_KP_PERIOD 
GGK_KP_DIVIDE 
GGK_KP_MULTIPLY 
GGK_KP_MINUS 
GGK_KP_PLUS 
GGK_KP_ENTER 
GGK_KP_EQUALS 
GGK_UP 
GGK_DOWN 
GGK_RIGHT 
GGK_LEFT 
GGK_INSERT 
GGK_HOME 
GGK_END 
GGK_PAGEUP 
GGK_PAGEDOWN 
GGK_F1 
GGK_F2 
GGK_F3 
GGK_F4 
GGK_F5 
GGK_F6 
GGK_F7 
GGK_F8 
GGK_F9 
GGK_F10 
GGK_F11 
GGK_F12 
GGK_F13 
GGK_F14 
GGK_F15 
GGK_NUMLOCK 
GGK_CAPSLOCK 
GGK_SCROLLOCK 
GGK_RSHIFT 
GGK_LSHIFT 
GGK_RCTRL 
GGK_LCTRL 
GGK_RALT 
GGK_LALT 
GGK_RMETA 
GGK_LMETA 
GGK_LSUPER  Left "Windows" key.
GGK_RSUPER  Right "Windows" key.
GGK_MODE  "Alt Gr" key
GGK_COMPOSE  Multi-key compose key.
GGK_HELP 
GGK_PRINT 
GGK_SYSREQ 
GGK_BREAK 
GGK_MENU 
GGK_POWER  Power Macintosh power key.
GGK_EURO  Some european keyboards.
GGK_UNDO  Atari keyboard has Undo.
GGK_LAST 

Definition at line 120 of file Base.h.

Function Documentation

GG::GG_FLAG_TYPE ( Alignment   ) 

Alignment flags.

void GG::KeypadKeyToPrintable ( Key &  key,
Flags< ModKey >  mod_keys 
)

Translates a printable key combination from a keypad press to the equivalent main-keyboard press.

key is only modified if it is a keypad value, and numlock is taken into account. For instance, with numlock on, a GGK_KP7 (which is equal to a nonprintable char value) becomes a GGK_7 (which equals '7', and is printable).

GG_API Clr GG::FloatClr ( float  r_,
float  g_,
float  b_,
float  a_ 
)

named ctor that constructs a Clr from four floats that represent the color channels (each must be >= 0.0 and <= 1.0)

GG_API bool GG::operator== ( const Clr &  rhs,
const Clr &  lhs 
)

returns true iff rhs and lhs are identical

GG_API bool GG::operator!= ( const Clr &  rhs,
const Clr &  lhs 
)

returns true iff rhs and lhs are different

GG_API void GG::glColor ( Clr  clr  ) 

Calls the appropriate version of glColor*() with clr.

GG_API Clr GG::LightColor ( Clr  clr  ) 

Returns the lightened version of color clr.

LightColor leaves the alpha channel unchanged, and multiplies the other channels by a some factor. (The factor is defined within LightColor().)

GG_API Clr GG::DarkColor ( Clr  clr  ) 

Returns the darkened version of color clr.

DarkColor leaves the alpha channel unchanged, and divides the other channels by a some factor. (The factor is defined within DarkColor().)

GG_API Clr GG::DisabledColor ( Clr  clr  ) 

Returns the "disabled" (grayed) version of color clr.

DisabledColor leaves the alpha channel unchanged, and adjusts the other channels in the direction of gray (GG_CLR_GRAY) by a factor between 0.0 and 1.0. (The factor is defined within DisabledColor().) This is used throughout the GG classes to render disabled controls.

Referenced by GG::Spin< T >::Render().

GG_API void GG::BeginScissorClipping ( Pt  ul,
Pt  lr 
)

Sets up a GL scissor box, so that everything outside of the screen region defined by points pt1 and pt2 is clipped out.

These coordinates should be in GG screen coordinates, with +y downward, instead of GL's screen coordinates.

Note:
Failing to call EndScissorClipping() after calling this function and before the next unmatched glPopAttrib() call may produce unexpected results.

GG_API void GG::BeginScissorClipping ( int  x1,
int  y1,
int  x2,
int  y2 
)

Sets up a GL scissor box, so that everything outside of the screen region defined by points (x1, y1) and (x2, y2) is clipped out.

These coordinates should be in GG screen coordinates, with +y downward, instead of GL's screen coordinates.

Note:
Failing to call EndScissorClipping() after calling this function and before the next unmatched glPopAttrib() call may produce unexpected results.

GG_API void GG::EndScissorClipping (  ) 

Ends the current GL scissor box, restoring GL scissor state to what it was before the corresponding call to BeginScissorClipping().

Note:
If there is not an outstanding call to BeginScissorClipping() when this function is called, this function does nothing.

GG_API void GG::FlatRectangle ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color,
Clr  border_color,
int  border_thick = 2 
)

Renders a rectangle starting at (x1,y1) and ending just before (x2,y2), and assumes that OpenGL in in a "2D" state.

The border is drawn in the desired thickness and color, then whatever is space is left inside that is filled with color color. No checking is done to make sure that border_thick * 2 is <= x2 - x1 (or <= y2 - y1, for that matter). This method of drawing and the 2D requirements are true for all functions that follow.

GG_API void GG::BeveledRectangle ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color,
Clr  border_color,
bool  up,
int  bevel_thick = 2,
bool  bevel_left = true,
bool  bevel_top = true,
bool  bevel_right = true,
bool  bevel_bottom = true 
)

Like FlatRectangle(), but with a "beveled" appearance.

The border_color used to create a lighter and a darker version of border_color, which are used to draw beveled edges around the inside of the rectangle to the desired thickness. If up is true, the beveled edges are lighter on the top and left, darker on the bottom and right, effecting a raised appearance. If up is false, the opposite happens, and the rectangle looks depressed. This is true of all the Beveled*() functions.

Referenced by GG::Spin< T >::Render().

GG_API void GG::FlatCheck ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color 
)

Draws a checkmark used to draw state buttons.

GG_API void GG::BeveledCheck ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color 
)

Like FlatCheck(), but with a raised appearance.

GG_API void GG::FlatX ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color 
)

Draws an X-mark used to draw state buttons.

GG_API void GG::BeveledX ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color 
)

Like FlatX(), but with a raised appearance.

GG_API void GG::Bubble ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color,
bool  up = true 
)

Draws a disk that appears to be a portion of a lit sphere.

The portion may appear raised or depressed.

GG_API void GG::FlatCircle ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color,
Clr  border_color,
int  thick = 2 
)

Draws a circle of thick pixels thickness in the color specified.

GG_API void GG::BeveledCircle ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color,
Clr  border_color,
bool  up = true,
int  bevel_thick = 2 
)

Draws a circle of thick pixels thickness in the color specified.

The circle appears to be beveled, and may be beveled in such a way as to appear raised or depressed.

GG_API void GG::FlatRoundedRectangle ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color,
Clr  border_color,
int  corner_radius = 5,
int  border_thick = 2 
)

Draws a rounded rectangle of the specified thickness.

The radius of the circles used to draw the corners is specified by corner_radius. Note that this means the rectangle should be at least 2 * corner_radius on a side, but as with all the other functions, no such check is performed.

GG_API void GG::BeveledRoundedRectangle ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color,
Clr  border_color,
bool  up,
int  corner_radius = 5,
int  bevel_thick = 2 
)

Like the FlatRoundedRectangle() function, but beveled (raised or depressed).

GG_API void GG::BubbleRectangle ( int  x1,
int  y1,
int  x2,
int  y2,
Clr  color,
bool  up,
int  corner_radius = 5 
)

Using the same techniques as in Bubble(), creates a rounded, bubbly rectangle.

template<class E>
EnumMap<E> GG::GetEnumMap (  )  [inline]

Returns a map of the values of an enum to the corresponding string representation of that value.

Definition at line 66 of file Enum.h.

template<class FlagType>
std::ostream & GG::operator<< ( std::ostream &  os,
Flags< FlagType >  flags 
) [inline]

Writes flags to os in the format "flag1 | flag2 | ... flagn".

Definition at line 334 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator| ( Flags< FlagType >  lhs,
Flags< FlagType >  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-or of lhs and rhs.

Definition at line 352 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator| ( Flags< FlagType >  lhs,
FlagType  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-or of lhs and rhs.

Definition at line 361 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator| ( FlagType  lhs,
Flags< FlagType >  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-or of lhs and rhs.

Definition at line 366 of file Flags.h.

template<class FlagType>
boost::enable_if< is_flag_type<FlagType>, Flags<FlagType>>::type GG::operator| ( FlagType  lhs,
FlagType  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-or of lhs and rhs.

Definition at line 375 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator & ( Flags< FlagType >  lhs,
Flags< FlagType >  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-and of lhs and rhs.

Definition at line 380 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator & ( Flags< FlagType >  lhs,
FlagType  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-and of lhs and rhs.

Definition at line 389 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator & ( FlagType  lhs,
Flags< FlagType >  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-and of lhs and rhs.

Definition at line 394 of file Flags.h.

template<class FlagType>
boost::enable_if< is_flag_type<FlagType>, Flags<FlagType>>::type GG::operator & ( FlagType  lhs,
FlagType  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-and of lhs and rhs.

Definition at line 403 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator^ ( Flags< FlagType >  lhs,
Flags< FlagType >  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-xor of lhs and rhs.

Definition at line 408 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator^ ( Flags< FlagType >  lhs,
FlagType  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-xor of lhs and rhs.

Definition at line 417 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator^ ( FlagType  lhs,
Flags< FlagType >  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-xor of lhs and rhs.

Definition at line 422 of file Flags.h.

template<class FlagType>
boost::enable_if< is_flag_type<FlagType>, Flags<FlagType>>::type GG::operator^ ( FlagType  lhs,
FlagType  rhs 
) [inline]

Returns a Flags object that consists of the bitwise-xor of lhs and rhs.

Definition at line 431 of file Flags.h.

template<class FlagType>
Flags<FlagType> GG::operator~ ( Flags< FlagType >  flags  )  [inline]

Returns a Flags object that consists of all the flags known to FlagSpec<FlagType>::instance() except those in flags.

Definition at line 436 of file Flags.h.

References GG::FlagSpec< FlagType >::begin(), and GG::FlagSpec< FlagType >::end().

template<class FlagType>
boost::enable_if< is_flag_type<FlagType>, Flags<FlagType>>::type GG::operator~ ( FlagType  flag  )  [inline]

Returns a Flags object that consists of all the flags known to FlagSpec<FlagType>::instance() except flag.

Definition at line 453 of file Flags.h.

GG_API std::string GG::RgbaTag ( const Clr &  c  ) 

returns a string of the form "<rgba r g b a>" from a Clr object with color channels r, b, g, a.

GG::GG_FLAG_TYPE ( TextFormat   ) 

Text formatting flags.

FontManager& GG::GetFontManager (  ) 

Returns the singleton FontManager instance.

GG::GG_EXCEPTION ( FailedFTLibraryInit   ) 

Thrown when initialization of the FreeType library fails.

GG_API bool GG::MatchesOrContains ( const Wnd *  lwnd,
const Wnd *  rwnd 
)

returns true if lwnd == rwnd or if lwnd contains rwnd

GG::GG_FLAG_TYPE ( ListBoxStyle   ) 

Styles for ListBox controls.

GG::GG_FLAG_TYPE ( MultiEditStyle   ) 

The styles of display and interaction for a MultiEdit.

GG_API PluginManager& GG::GetPluginManager (  ) 

Returns the singleton PluginManager instance.

GG_API bool GG::operator== ( const Pt &  lhs,
const Pt &  rhs 
) [inline]

returns true if lhs is identical to rhs

Definition at line 107 of file PtRect.h.

References GG::Pt::x, and GG::Pt::y.

GG_API bool GG::operator!= ( const Pt &  lhs,
const Pt &  rhs 
) [inline]

returns true if lhs differs from rhs

Definition at line 108 of file PtRect.h.

GG_API bool GG::operator< ( const Pt &  lhs,
const Pt &  rhs 
) [inline]

returns true if lhs.x and lhs.y are both less than the corresponding components of rhs

Definition at line 109 of file PtRect.h.

References GG::Pt::x, and GG::Pt::y.

GG_API bool GG::operator> ( const Pt &  lhs,
const Pt &  rhs 
) [inline]

returns true if lhs.x and lhs.y are both greater than the corresponding components of rhs

Definition at line 110 of file PtRect.h.

References GG::Pt::x, and GG::Pt::y.

GG_API bool GG::operator<= ( const Pt &  lhs,
const Pt &  rhs 
) [inline]

returns true if lhs.x and lhs.y are both less than or equal to the corresponding components of rhs

Definition at line 111 of file PtRect.h.

References GG::Pt::x, and GG::Pt::y.

GG_API bool GG::operator>= ( const Pt &  lhs,
const Pt &  rhs 
) [inline]

returns true if lhs.x and lhs.y are both greater than or equal to the corresponding components of rhs

Definition at line 112 of file PtRect.h.

References GG::Pt::x, and GG::Pt::y.

GG_API Pt GG::operator+ ( const Pt &  lhs,
const Pt &  rhs 
) [inline]

returns the vector sum of lhs and rhs

Definition at line 113 of file PtRect.h.

References GG::Pt::x, and GG::Pt::y.

GG_API Pt GG::operator- ( const Pt &  lhs,
const Pt &  rhs 
) [inline]

returns the vector difference of lhs and rhs

Definition at line 114 of file PtRect.h.

References GG::Pt::x, and GG::Pt::y.

GG_API std::ostream& GG::operator<< ( std::ostream &  os,
const Pt &  pt 
)

Pt stream-output operator for debug output.

GG_API bool GG::operator== ( const Rect &  lhs,
const Rect &  rhs 
) [inline]

returns true if lhs is identical to rhs

Definition at line 119 of file PtRect.h.

References GG::Rect::lr, GG::Rect::ul, GG::Pt::x, and GG::Pt::y.

GG_API bool GG::operator!= ( const Rect &  lhs,
const Rect &  rhs 
) [inline]

returns true if lhs differs from rhs

Definition at line 122 of file PtRect.h.

GG_API Rect GG::operator+ ( const Rect &  rect,
const Pt &  pt 
) [inline]

returns rect shifted by adding pt to each corner

Definition at line 124 of file PtRect.h.

References GG::Rect::lr, and GG::Rect::ul.

GG_API Rect GG::operator- ( const Rect &  rect,
const Pt &  pt 
) [inline]

returns rect shifted by subtracting pt from each corner

Definition at line 125 of file PtRect.h.

References GG::Rect::lr, and GG::Rect::ul.

GG_API Rect GG::operator+ ( const Pt &  pt,
const Rect &  rect 
) [inline]

returns rect shifted by adding pt to each corner

Definition at line 126 of file PtRect.h.

GG_API Rect GG::operator- ( const Pt &  pt,
const Rect &  rect 
) [inline]

returns rect shifted by subtracting pt from each corner

Definition at line 127 of file PtRect.h.

GG_API std::ostream& GG::operator<< ( std::ostream &  os,
const Rect &  rect 
)

Rect stream-output operator for debug output.

template<class SigT>
boost::signals::connection GG::Connect ( SigT &  sig,
const typename SigT::slot_type &  _slot,
boost::signals::connect_position  at = boost::signals::at_back 
) [inline]

connects a signal to a slot functor of the same signature, putting _slot in slot group 0, at position at within group 0.

Slot call groups are called in ascending order.

Definition at line 51 of file SignalsAndSlots.h.

template<class SigT>
boost::signals::connection GG::Connect ( SigT &  sig,
const typename SigT::slot_type &  _slot,
int  grp,
boost::signals::connect_position  at = boost::signals::at_back 
) [inline]

connects a signal to a slot functor of the same signature, putting _slot in slot group grp, at position at within group grp.

Slot call groups are called in ascending order.

Definition at line 60 of file SignalsAndSlots.h.

template<class C, class R, class T1, class T2 GG_SIGNALS_SIGNAL_TEMPLATE_PARMS>
boost::signals::connection GG::Connect ( boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &  sig,
R(T1::*)(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS)  fn,
T2  obj,
boost::signals::connect_position  at = boost::signals::at_back 
) [inline]

connects a signal to a const member function of a specific object that has the same function signature, putting R in slot group 0.

Slot call groups are called in ascending order. Overloads exist for const- and non-const- versions with 0 to 8 arguments. 8 was picked as the max simply because boost::bind only supports up to 8 args as of this writing.

Definition at line 57 of file SignalTemplate.h.

template<class C, class R, class T1, class T2 GG_SIGNALS_SIGNAL_TEMPLATE_PARMS>
boost::signals::connection GG::Connect ( boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &  sig,
R(T1::*)(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS)  fn,
T2  obj,
int  grp,
boost::signals::connect_position  at = boost::signals::at_back 
) [inline]

connects a signal to a const member function of a specific object that has the same function signature, putting R in slot group grp.

Slot call groups are called in ascending order. Overloads exist for const- and non-const- versions with 0 to 8 arguments. 8 was picked as the max simply because boost::bind only supports up to 8 args as of this writing.

Definition at line 87 of file SignalTemplate.h.

template<class C, class R GG_SIGNALS_SIGNAL_TEMPLATE_PARMS>
boost::signals::connection GG::Connect ( boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &  sig1,
boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &  sig2,
boost::signals::connect_position  at = boost::signals::at_back 
) [inline]

connects a signal to another signal of the same signature, establishing signal-forwarding.

sig1 places sig2 in its slot group 0.

Definition at line 117 of file SignalTemplate.h.

template<class C, class R GG_SIGNALS_SIGNAL_TEMPLATE_PARMS>
boost::signals::connection GG::Connect ( boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &  sig1,
boost::signal< R(GG_SIGNALS_SIGNAL_TEMPLATE_ARGS), C > &  sig2,
int  grp,
boost::signals::connect_position  at = boost::signals::at_back 
) [inline]

connects a signal to another signal of the same signature, establishing signal-forwarding.

sig1 places sig2 in its slot group grp.

Definition at line 130 of file SignalTemplate.h.

GG::GG_FLAG_TYPE ( GraphicStyle   ) 

Styles for StaticGraphic controls.

TextureManager& GG::GetTextureManager (  ) 

Returns the singleton TextureManager instance.

GG::GG_FLAG_TYPE ( WndFlag   ) 

Wnd creation flags type.

Variable Documentation

GG_API const Alignment GG::ALIGN_NONE

No alignment selected.

GG_API const Alignment GG::ALIGN_VCENTER

Vertically-centered.

GG_API const Alignment GG::ALIGN_TOP

Aligned to top.

GG_API const Alignment GG::ALIGN_BOTTOM

Aligned to bottom.

GG_API const Alignment GG::ALIGN_CENTER

Horizontally-centered.

GG_API const Alignment GG::ALIGN_LEFT

Aligned to left.

GG_API const Alignment GG::ALIGN_RIGHT

Aligned to right.

GG_API const TextFormat GG::FORMAT_NONE

Default format selected.

GG_API const TextFormat GG::FORMAT_VCENTER

Centers text vertically.

GG_API const TextFormat GG::FORMAT_TOP

Top-justifies text.

GG_API const TextFormat GG::FORMAT_BOTTOM

Justifies the text to the bottom of the rectangle.

GG_API const TextFormat GG::FORMAT_CENTER

Centers text horizontally in the rectangle.

GG_API const TextFormat GG::FORMAT_LEFT

Aligns text to the left.

GG_API const TextFormat GG::FORMAT_RIGHT

Aligns text to the right.

GG_API const TextFormat GG::FORMAT_WORDBREAK

Breaks words. Lines are automatically broken between words if a word would extend past the edge of the control's bounding rectangle. (As always, a '\n' also breaks the line.).

GG_API const TextFormat GG::FORMAT_LINEWRAP

Lines are automatically broken when the next character (or space) would be drawn outside the the text rectangle.

GG_API const TextFormat GG::FORMAT_IGNORETAGS

Text formatting tags (e.g. <rgba 0 0 0 255>) are treated as regular text.

GG_API const ListBoxStyle GG::LIST_NONE

Default style selected.

GG_API const ListBoxStyle GG::LIST_VCENTER

Cells are aligned with the top of the list box control.

GG_API const ListBoxStyle GG::LIST_TOP

Cells are aligned with the top of the list box control. This is the default.

GG_API const ListBoxStyle GG::LIST_BOTTOM

Cells are aligned with the bottom of the list box control.

GG_API const ListBoxStyle GG::LIST_CENTER

Cells are center-aligned.

GG_API const ListBoxStyle GG::LIST_LEFT

Cells are left-aligned. This is the default.

GG_API const ListBoxStyle GG::LIST_RIGHT

Cells are right-aligned.

GG_API const ListBoxStyle GG::LIST_NOSORT

List items are not sorted. Items are sorted by default. When used with drag-and-drop, this style allows arbitrary rearrangement of list elements by dragging.

GG_API const ListBoxStyle GG::LIST_SORTDESCENDING

Items are sorted based on item text in descending order. Ascending order is the default.

GG_API const ListBoxStyle GG::LIST_NOSEL

No selection, dragging, or dropping allowed. This makes the list box effectively read-only.

GG_API const ListBoxStyle GG::LIST_SINGLESEL

Only one item at a time can be selected. By default, multiple items may be selected.

GG_API const ListBoxStyle GG::LIST_QUICKSEL

Each click toggles an item without affecting any others; ignored when used with LIST_SINGLESEL.

GG_API const ListBoxStyle GG::LIST_USERDELETE

Allows user to remove selected items by pressing the delete key.

GG_API const ListBoxStyle GG::LIST_BROWSEUPDATES

Causes a signal to be emitted whenever the mouse moves over ("browses") a row.

GG_API const MultiEditStyle GG::MULTI_NONE

Default style selected.

GG_API const MultiEditStyle GG::MULTI_WORDBREAK

Breaks words. Lines are automatically broken between words if a word would extend past the edge of the control's bounding rectangle. (As always, a '\n' also breaks the line.).

GG_API const MultiEditStyle GG::MULTI_LINEWRAP

Lines are automatically broken when the next character (or space) would be drawn outside the the text rectangle.

GG_API const MultiEditStyle GG::MULTI_VCENTER

Vertically centers text.

GG_API const MultiEditStyle GG::MULTI_TOP

Aligns text to the top.

GG_API const MultiEditStyle GG::MULTI_BOTTOM

Aligns text to the bottom.

GG_API const MultiEditStyle GG::MULTI_CENTER

Centers text.

GG_API const MultiEditStyle GG::MULTI_LEFT

Aligns text to the left.

GG_API const MultiEditStyle GG::MULTI_RIGHT

Aligns text to the right.

GG_API const MultiEditStyle GG::MULTI_READ_ONLY

The control is not user-interactive, only used to display text. Text can still be programmatically altered and selected.

GG_API const MultiEditStyle GG::MULTI_TERMINAL_STYLE

The text in the control is displayed so that the bottom is visible, instead of the top.

GG_API const MultiEditStyle GG::MULTI_INTEGRAL_HEIGHT

The height of the control will always be a multiple of the height of one row (fractions rounded down).

GG_API const MultiEditStyle GG::MULTI_NO_VSCROLL

Vertical scrolling is not available, and there is no vertical scroll bar.

GG_API const MultiEditStyle GG::MULTI_NO_HSCROLL

Horizontal scrolling is not available, and there is no horizontal scroll bar.

GG_API const Flags<MultiEditStyle> GG::MULTI_NO_SCROLL

Scrolls are not used for this control.

GG_API const GraphicStyle GG::GRAPHIC_NONE

Default style selected.

GG_API const GraphicStyle GG::GRAPHIC_VCENTER

Centers graphic vertically.

GG_API const GraphicStyle GG::GRAPHIC_TOP

Top-justifies graphic.

GG_API const GraphicStyle GG::GRAPHIC_BOTTOM

Justifies the graphic to the bottom of the rectangle.

GG_API const GraphicStyle GG::GRAPHIC_CENTER

Centers graphic horizontally in the rectangle.

GG_API const GraphicStyle GG::GRAPHIC_LEFT

Aligns graphic to the left.

GG_API const GraphicStyle GG::GRAPHIC_RIGHT

Aligns graphic to the right.

GG_API const GraphicStyle GG::GRAPHIC_FITGRAPHIC

Scales graphic to fit within the StaticGraphic's window dimensions.

GG_API const GraphicStyle GG::GRAPHIC_SHRINKFIT

Like GRAPHIC_FITGRAPHIC, but this one only scales the image if it otherwise would not fit in the window.

GG_API const GraphicStyle GG::GRAPHIC_PROPSCALE

If GRAPHIC_FITGRAPHIC or GRAPHIC_SHRINKFIT is used, this ensures scaling is done proportionally.

GG_API const WndFlag GG::CLICKABLE

Clicks hit this window, rather than passing through it.

GG_API const WndFlag GG::REPEAT_BUTTON_DOWN

When a mouse button is held down over this window, it expects to receive multiple *ButtonDown messages.

GG_API const WndFlag GG::DRAGABLE

This window can be dragged around independently.

GG_API const WndFlag GG::RESIZABLE

This window can be resized by the user, with the mouse.

GG_API const WndFlag GG::ONTOP

This windows is an "on-top" window, and will always appear above all non-on-top and non-modal windows.

Note that this only applies to top-level (Parent()-less) Wnds.

GG_API const WndFlag GG::MODAL

This window is modal; while it is active, no other windows are interactive.

Modal windows are considered above "on-top" windows, and should not be flagged as OnTop. Note that this only applies to top-level (Parent()-less) Wnds.

GG_API const ModKey GG::MOD_KEY_NONE

No modifier key.

GG_API const ModKey GG::MOD_KEY_LSHIFT

The left Shift key.

GG_API const ModKey GG::MOD_KEY_RSHIFT

The right Shift key.

GG_API const ModKey GG::MOD_KEY_LCTRL

The left Control key.

GG_API const ModKey GG::MOD_KEY_RCTRL

The right Control key.

GG_API const ModKey GG::MOD_KEY_LALT

The left Alt key.

GG_API const ModKey GG::MOD_KEY_RALT

The right Alt key.

GG_API const ModKey GG::MOD_KEY_LMETA

The left Meta key.

GG_API const ModKey GG::MOD_KEY_RMETA

The right Meta key.

GG_API const ModKey GG::MOD_KEY_NUM

The Num Lock key.

GG_API const ModKey GG::MOD_KEY_CAPS

The Caps Lock key.

GG_API const ModKey GG::MOD_KEY_MODE

The Mode key.

GG_API const Flags<ModKey> GG::MOD_KEY_CTRL

Either Control key.

GG_API const Flags<ModKey> GG::MOD_KEY_SHIFT

Either Shift key.

GG_API const Flags<ModKey> GG::MOD_KEY_ALT

Either Alt key.

GG_API const Flags<ModKey> GG::MOD_KEY_META

Either Meta key.

Generated on Wed Mar 26 14:35:42 2008 for GG by  doxygen 1.5.2