GG
List of all members
GG::TextBoxBrowseInfoWnd Class Reference

#include <BrowseInfoWnd.h>

Inheritance diagram for GG::TextBoxBrowseInfoWnd:
GG::BrowseInfoWnd GG::Wnd

Structors

 TextBoxBrowseInfoWnd (X w, const boost::shared_ptr< Font > &font, Clr color, Clr border_color, Clr text_color, Flags< TextFormat > format=FORMAT_LEFT|FORMAT_WORDBREAK, unsigned int border_width=2, unsigned int text_margin=4)
 
 TextBoxBrowseInfoWnd ()
 

Accessors

virtual bool WndHasBrowseInfo (const Wnd *wnd, std::size_t mode) const
 
bool TextFromTarget () const
 
const std::string & Text () const
 
const boost::shared_ptr< Font > & GetFont () const
 
Clr Color () const
 
Clr BorderColor () const
 
Clr TextColor () const
 
Flags< TextFormat > GetTextFormat () const
 
unsigned int BorderWidth () const
 
unsigned int TextMargin () const
 

Mutators

void SetText (const std::string &str)
 
virtual void Render ()
 
void SetTextFromTarget (bool b)
 
void SetFont (const boost::shared_ptr< Font > &font)
 
void SetColor (Clr color)
 
void SetBorderColor (Clr border_color)
 
void SetTextColor (Clr text_color)
 
void SetTextFormat (Flags< TextFormat > format)
 
void SetBorderWidth (unsigned int border_width)
 
void SetTextMargin (unsigned int text_margin)
 

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::BrowseInfoWnd
void Update (std::size_t mode, const Wnd *target)
 
void SetCursorPosition (const Pt &cursor_pos)
 
- 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)
 
- Public Attributes inherited from GG::BrowseInfoWnd
boost::function< Pt(const Pt
&, const boost::shared_ptr
< Cursor > &, const
BrowseInfoWnd &, const Wnd &) > 
PositionWnd
 
- 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::BrowseInfoWnd
 BrowseInfoWnd ()
 
 BrowseInfoWnd (X x, Y y, X w, Y h)
 
- 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 KeyPress (Key key, boost::uint32_t key_code_point, Flags< ModKey > mod_keys)
 
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 subclass of BrowseInfoWnd that displays text in a box, optionally with a border.

The typical use case is for TextBoxBrowseInfoWnd to get the appropriate text for the current mode by calling BrowseInfoText() on its target Wnd. It may also be used to display static text, by setting SetTextFromTarget(false) and setting the desired text with SetText().

Definition at line 105 of file BrowseInfoWnd.h.

Constructor & Destructor Documentation

GG::TextBoxBrowseInfoWnd::TextBoxBrowseInfoWnd ( X  w,
const boost::shared_ptr< Font > &  font,
Clr  color,
Clr  border_color,
Clr  text_color,
Flags< TextFormat >  format = FORMAT_LEFT|FORMAT_WORDBREAK,
unsigned int  border_width = 2,
unsigned int  text_margin = 4 
)

basic ctor

Member Function Documentation

virtual bool GG::TextBoxBrowseInfoWnd::WndHasBrowseInfo ( const Wnd wnd,
std::size_t  mode 
) const
virtual

Returns true iff wnd's browse mode mode contains browse info that is usable by this BrowseInfoWnd. This method is used by GUI to determine whether a Wnd w has suitable browse info available; if not, w's ancestors may instead be asked for browse info recursively.

Implements GG::BrowseInfoWnd.

virtual void GG::TextBoxBrowseInfoWnd::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().

Implements GG::BrowseInfoWnd.


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