GG
Public Attributes | List of all members
GG::BrowseInfoWnd Class Referenceabstract

#include <BrowseInfoWnd.h>

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

Public Attributes

boost::function< Pt(const Pt
&, const boost::shared_ptr
< Cursor > &, const
BrowseInfoWnd &, const Wnd &) > 
PositionWnd
 

Accessors

virtual bool WndHasBrowseInfo (const Wnd *wnd, std::size_t mode) const =0
 

Mutators

virtual void Render ()=0
 
void Update (std::size_t mode, const Wnd *target)
 
void SetCursorPosition (const Pt &cursor_pos)
 

Structors

 BrowseInfoWnd ()
 
 BrowseInfoWnd (X x, Y y, X w, Y h)
 

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 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

The abstract base class for all browse-info display windows.

Each frame that a BrowseInfoWnd is displayed, its Update() method is called. The Wnd* parameter passed in this call is the window about which the BrowseInfoWnd is displaying info (the target Wnd); the BrowseInfoWnd can collect whatever information it requires from the target Wnd before it is rendered. Note that a BrowseInfoWnd should never be INTERACTIVE.

Definition at line 50 of file BrowseInfoWnd.h.

Member Function Documentation

virtual bool GG::BrowseInfoWnd::WndHasBrowseInfo ( const Wnd wnd,
std::size_t  mode 
) const
pure 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.

Implemented in GG::TextBoxBrowseInfoWnd.

virtual void GG::BrowseInfoWnd::Render ( )
pure 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.

Implemented in GG::TextBoxBrowseInfoWnd.

void GG::BrowseInfoWnd::Update ( std::size_t  mode,
const Wnd target 
)

Collects data from target that is needed by Render(). Note that the one datum that is always available for any Wnd is the text to display for mode, accessible through Wnd::BrowseInfoText() (though this may be the empty string). Other data that are provided by a Wnd subclass can be recovered by casting target to its actual subclass type.

void GG::BrowseInfoWnd::SetCursorPosition ( const Pt cursor_pos)

Sets the current cursor position to the one given.

Member Data Documentation

boost::function< Pt (const Pt&, const boost::shared_ptr<Cursor>&, const BrowseInfoWnd&, const Wnd&) > GG::BrowseInfoWnd::PositionWnd
mutable

If set by the user, this function is used to determine the position of this BrowseInfoWnd. It takes the current cursor position, the currently-set cursor, this BrowseInfoWnd, and the Wnd that is displaying this BrowseInfoWnd as parameters, and returns the desired upper-left corner of this BrowseInfoWnd.

Definition at line 83 of file BrowseInfoWnd.h.


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