GG
List of all members
GG::ThreeButtonDlg Class Reference

#include <ThreeButtonDlg.h>

Inheritance diagram for GG::ThreeButtonDlg:
GG::Wnd

Structors

 ThreeButtonDlg (X x, Y y, X w, Y h, const std::string &msg, const boost::shared_ptr< Font > &font, Clr color, Clr border_color, Clr button_color, Clr text_color, std::size_t buttons, const std::string &zero="", const std::string &one="", const std::string &two="")
 
 ThreeButtonDlg (X w, Y h, const std::string &msg, const boost::shared_ptr< Font > &font, Clr color, Clr border_color, Clr button_color, Clr text_color, std::size_t buttons, const std::string &zero="", const std::string &one="", const std::string &two="")
 
 ThreeButtonDlg ()
 

Accessors

Clr ButtonColor () const
 
std::size_t Result () const
 
std::size_t DefaultButton () const
 
std::size_t EscapeButton () const
 

Mutators

virtual void Render ()
 
virtual void KeyPress (Key key, boost::uint32_t key_code_point, Flags< ModKey > mod_keys)
 
void SetButtonColor (Clr color)
 
void SetDefaultButton (std::size_t i)
 
void SetEscapeButton (std::size_t i)
 

Additional Inherited Members

- Public Types inherited from GG::Wnd
enum  ChildClippingMode {
  DontClip,
  ClipToClient,
  ClipToWindow,
  ClipToClientAndWindowSeparately
}
 
typedef std::map< const Wnd
*, bool >::iterator 
DropsAcceptableIter
 
- Public Member Functions inherited from GG::Wnd
virtual ~Wnd ()
 
bool Interactive () const
 
bool RepeatButtonDown () const
 
bool Dragable () const
 
bool Resizable () const
 
bool OnTop () const
 
bool Modal () const
 
ChildClippingMode GetChildClippingMode () const
 
bool NonClientChild () const
 
bool Visible () const
 
const std::string & Name () const
 
const std::string & DragDropDataType () const
 
virtual void DropsAcceptable (DropsAcceptableIter first, DropsAcceptableIter last, const Pt &pt) const
 
Pt UpperLeft () const
 
Pt LowerRight () const
 
Pt RelativeUpperLeft () const
 
Pt RelativeLowerRight () const
 
X Width () const
 
Y Height () const
 
int ZOrder () const
 
Pt Size () const
 
Pt MinSize () const
 
Pt MaxSize () const
 
virtual Pt MinUsableSize () const
 
virtual Pt ClientUpperLeft () const
 
virtual Pt ClientLowerRight () const
 
Pt ClientSize () const
 
X ClientWidth () const
 
Y ClientHeight () const
 
Pt ScreenToWindow (const Pt &pt) const
 
Pt ScreenToClient (const Pt &pt) const
 
virtual bool InWindow (const Pt &pt) const
 
virtual bool InClient (const Pt &pt) const
 
const std::list< Wnd * > & Children () const
 
WndParent () const
 
WndRootParent () const
 
LayoutGetLayout () const
 
LayoutContainingLayout () const
 
const std::vector
< BrowseInfoMode > & 
BrowseModes () const
 
const std::string & BrowseInfoText (std::size_t mode) const
 
const boost::shared_ptr
< StyleFactory > & 
GetStyleFactory () const
 
virtual WndRegion WindowRegion (const Pt &pt) const
 
void SetDragDropDataType (const std::string &data_type)
 
virtual void StartingChildDragDrop (const Wnd *wnd, const Pt &offset)
 
virtual void AcceptDrops (const std::vector< Wnd * > &wnds, const Pt &pt)
 
virtual void CancellingChildDragDrop (const std::vector< const Wnd * > &wnds)
 
virtual void ChildrenDraggedAway (const std::vector< Wnd * > &wnds, const Wnd *destination)
 
void SetName (const std::string &name)
 
void Hide (bool children=true)
 
void Show (bool children=true)
 
virtual void ModalInit ()
 
void SetChildClippingMode (ChildClippingMode mode)
 
void NonClientChild (bool b)
 
void MoveTo (const Pt &pt)
 
void OffsetMove (const Pt &pt)
 
virtual void SizeMove (const Pt &ul, const Pt &lr)
 
void Resize (const Pt &sz)
 
void SetMinSize (const Pt &sz)
 
void SetMaxSize (const Pt &sz)
 
void AttachChild (Wnd *wnd)
 
void MoveChildUp (Wnd *wnd)
 
void MoveChildDown (Wnd *wnd)
 
void DetachChild (Wnd *wnd)
 
void DetachChildren ()
 
void DeleteChild (Wnd *wnd)
 
void DeleteChildren ()
 
void InstallEventFilter (Wnd *wnd)
 
void RemoveEventFilter (Wnd *wnd)
 
void HorizontalLayout ()
 
void VerticalLayout ()
 
void GridLayout ()
 
void SetLayout (Layout *layout)
 
void RemoveLayout ()
 
LayoutDetachLayout ()
 
void SetLayoutBorderMargin (unsigned int margin)
 
void SetLayoutCellMargin (unsigned int margin)
 
virtual bool Run ()
 
void EndRun ()
 
void SetBrowseModeTime (unsigned int time, std::size_t mode=0)
 
void SetBrowseInfoWnd (const boost::shared_ptr< BrowseInfoWnd > &wnd, std::size_t mode=0)
 
void ClearBrowseInfoWnd (std::size_t mode=0)
 
void SetBrowseText (const std::string &text, std::size_t mode=0)
 
void SetBrowseModes (const std::vector< BrowseInfoMode > &modes)
 
void SetStyleFactory (const boost::shared_ptr< StyleFactory > &factory)
 
 GG_ABSTRACT_EXCEPTION (Exception)
 
 GG_CONCRETE_EXCEPTION (BadLayout, GG::Wnd, Exception)
 
- Static Public Member Functions inherited from GG::Wnd
static unsigned int DefaultBrowseTime ()
 
static void SetDefaultBrowseTime (unsigned int time)
 
static const boost::shared_ptr
< BrowseInfoWnd > & 
DefaultBrowseInfoWnd ()
 
static void SetDefaultBrowseInfoWnd (const boost::shared_ptr< BrowseInfoWnd > &browse_info_wnd)
 
- Protected Types inherited from GG::Wnd
enum  DragDropRenderingState {
  NOT_DRAGGED,
  IN_PLACE_COPY,
  DRAGGED_OVER_UNACCEPTING_DROP_TARGET,
  DRAGGED_OVER_ACCEPTING_DROP_TARGET
}
 
- Protected Member Functions inherited from GG::Wnd
 Wnd ()
 
 Wnd (X x, Y y, X w, Y h, Flags< WndFlag > flags=INTERACTIVE|DRAGABLE)
 
DragDropRenderingState GetDragDropRenderingState () const
 
virtual void LButtonDown (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void LDrag (const Pt &pt, const Pt &move, Flags< ModKey > mod_keys)
 
virtual void LButtonUp (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void LClick (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void LDoubleClick (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void MButtonDown (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void MDrag (const Pt &pt, const Pt &move, Flags< ModKey > mod_keys)
 
virtual void MButtonUp (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void MClick (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void MDoubleClick (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void RButtonDown (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void RDrag (const Pt &pt, const Pt &move, Flags< ModKey > mod_keys)
 
virtual void RButtonUp (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void RClick (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void RDoubleClick (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void MouseEnter (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void MouseHere (const Pt &pt, Flags< ModKey > mod_keys)
 
virtual void MouseLeave ()
 
virtual void MouseWheel (const Pt &pt, int move, Flags< ModKey > mod_keys)
 
virtual void DragDropEnter (const Pt &pt, const std::map< Wnd *, Pt > &drag_drop_wnds, Flags< ModKey > mod_keys)
 
virtual void DragDropHere (const Pt &pt, const std::map< Wnd *, Pt > &drag_drop_wnds, Flags< ModKey > mod_keys)
 
virtual void DragDropLeave ()
 
virtual void KeyRelease (Key key, boost::uint32_t key_code_point, Flags< ModKey > mod_keys)
 
virtual void GainingFocus ()
 
virtual void LosingFocus ()
 
virtual void TimerFiring (unsigned int ticks, Timer *timer)
 
virtual bool EventFilter (Wnd *w, const WndEvent &event)
 
void HandleEvent (const WndEvent &event)
 
void ForwardEventToParent ()
 
void BeginClipping ()
 
void EndClipping ()
 
void BeginNonclientClipping ()
 
void EndNonclientClipping ()
 
- Protected Attributes inherited from GG::Wnd
bool m_done
 

Detailed Description

A general pop-up message or user input box with one, two, or three buttons.

This is designed to be used as a generic message window, with just an "ok" button, or for any input consisting of only two or three choices, such as "yes" and "no", "abort", "retry", and "fail", etc. The enter key can be pressed to select the default button; the first button is always the default, unless the user sets a different one via SetDefaultButton(). Similarly, the escape key can be pressed to select the button that will get the user out of the dialog without taking any action, if one exists; the last button is always the escape button, unless a different one is set via SetEscapeButton(). Note that this means that in a one-button dialog both enter and escape do the same thing. The default labels for the buttons depends on the number of buttons. For a one-button dialog, the default label is "ok"; for a two-button dialog, the default labels are "ok" and "cancel"; and for a three-button dialog, the default labels are "yes", "no", and "cancel".

Definition at line 57 of file ThreeButtonDlg.h.

Constructor & Destructor Documentation

GG::ThreeButtonDlg::ThreeButtonDlg ( X  x,
Y  y,
X  w,
Y  h,
const std::string &  msg,
const boost::shared_ptr< Font > &  font,
Clr  color,
Clr  border_color,
Clr  button_color,
Clr  text_color,
std::size_t  buttons,
const std::string &  zero = "",
const std::string &  one = "",
const std::string &  two = "" 
)

Basic ctor

GG::ThreeButtonDlg::ThreeButtonDlg ( X  w,
Y  h,
const std::string &  msg,
const boost::shared_ptr< Font > &  font,
Clr  color,
Clr  border_color,
Clr  button_color,
Clr  text_color,
std::size_t  buttons,
const std::string &  zero = "",
const std::string &  one = "",
const std::string &  two = "" 
)

Ctor that automatically centers the dialog in the app's area

Member Function Documentation

virtual void GG::ThreeButtonDlg::Render ( )
virtual

Draws this Wnd. Note that Wnds being dragged for a drag-and-drop operation are rendered twice – once in-place as normal, once in the location of the drag operation, attached to the cursor. Such Wnds may wish to render themselves differently in those two cases. To determine which render is being performed, they can call GUI::GetGUI()->RenderingDragDropWnds().

Reimplemented from GG::Wnd.

virtual void GG::ThreeButtonDlg::KeyPress ( Key  key,
boost::uint32_t  key_code_point,
Flags< ModKey >  mod_keys 
)
virtual

Respond to down-keystrokes (focus window only). A window may receive KeyPress() messages passed up to it from its children. For instance, Control-derived classes pass KeyPress() messages to their Parent() windows by default.

Note
Though mouse clicks consist of a press and a release, all Control classes by default respond immediately to KeyPress(), not KeyRelease(); in fact, by default no Wnd class does anything at all on a KeyRelease event.
key_code_point will be zero if Unicode support is unavailable.

Reimplemented from GG::Wnd.


The documentation for this class was generated from the following file: