GG
Public Types

GG::Scroll Class Reference

This is a basic scrollbar control. More...

#include <Scroll.h>

Inheritance diagram for GG::Scroll:
GG::Control GG::Wnd

List of all members.

Public Types

enum  ScrollRegion

Signal Types

typedef boost::signal< void(int,
int, int, int)> 
ScrolledSignalType
typedef boost::signal< void(int,
int, int, int)> 
ScrolledAndStoppedSignalType

Structors

 Scroll (X x, Y y, X w, Y h, Orientation orientation, Clr color, Clr interior, Flags< WndFlag > flags=INTERACTIVE|REPEAT_BUTTON_DOWN)
 Scroll ()

Accessors

ScrolledSignalType ScrolledSignal
ScrolledAndStoppedSignalType ScrolledAndStoppedSignal
virtual Pt MinUsableSize () const
std::pair< int, int > PosnRange () const
std::pair< int, int > ScrollRange () const
unsigned int LineSize () const
unsigned int PageSize () const
Clr InteriorColor () const
Orientation ScrollOrientation () const
unsigned int TabSpace () const
unsigned int TabWidth () const
ScrollRegion RegionUnder (const Pt &pt)
ButtonTabButton () const
ButtonIncrButton () const
ButtonDecrButton () const

Mutators

virtual void Render ()
virtual void SizeMove (const Pt &ul, const Pt &lr)
virtual void Disable (bool b=true)
virtual void SetColor (Clr c)
void SetInteriorColor (Clr c)
void SizeScroll (int min, int max, unsigned int line, unsigned int page)
void SetMax (int max)
void SetMin (int min)
void SetLineSize (unsigned int line)
void SetPageSize (unsigned int page)
void ScrollTo (int p)
void ScrollLineIncr ()
void ScrollLineDecr ()
void ScrollPageIncr ()
void ScrollPageDecr ()
virtual void DefineAttributes (WndEditor *editor)
virtual void LButtonDown (const Pt &pt, 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 MouseHere (const Pt &pt, Flags< ModKey > mod_keys)
virtual bool EventFilter (Wnd *w, const WndEvent &event)

Detailed Description

This is a basic scrollbar control.

The range of the values the scrollbar represents is [m_range_min, m_range_max]. However, m_posn can only range over [m_range_min, m_range_max - m_page_sz], because the tab has a logical width of m_page_sz. So the region of the scrollbar's range being viewed at any one time is [m_posn, m_posn + m_page_sz]. (m_posn + m_page_sz is actually the last + 1 element of the range.) The parent of the control is notified of a scroll via ScrolledSignalType signals; these are emitted from the Scroll*() functions and the UpdatePosn() function. This should cover every instance in which m_posn is altered. The parent can poll the control to get its current view area with a call to GetPosnRange(). An increase in a vertical scroll is down, and a decrease is up; since GG assumes the y-coordinates are downwardly increasing. The rather plain default buttons and tab can be replaced by any Button-derived controls desired. However, if you want to serialize a Scroll that has custom buttons and/or tab, you must make sure they are properly registered. See the boost serialization documentation for details.

Definition at line 56 of file Scroll.h.


Constructor & Destructor Documentation

GG::Scroll::Scroll ( X  x,
Y  y,
X  w,
Y  h,
Orientation  orientation,
Clr  color,
Clr  interior,
Flags< WndFlag >  flags = INTERACTIVE|REPEAT_BUTTON_DOWN 
)

Ctor.


Member Function Documentation

virtual Pt GG::Scroll::MinUsableSize ( ) const [virtual]

Returns the size of the minimum bounding box that can enclose the Wnd and still show all of its elements, plus enough room for interaction with those elements (if applicable). For example, a TextControl's MinUsableSize() is just the area of its text, and a Scroll's MinUsableSize() is the combined sizes of its up-button, down-button, and tab (plus a bit of room in which to drag the tab).

Reimplemented from GG::Wnd.

virtual void GG::Scroll::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::Control.

virtual void GG::Scroll::SizeMove ( const Pt ul,
const Pt lr 
) [virtual]

Resizes and/or moves window to new upper-left and lower right boundaries.

Reimplemented from GG::Wnd.

virtual void GG::Scroll::DefineAttributes ( WndEditor *  editor) [virtual]

Provides the attributes of this object that are appropriate for a user to edit in a WndEditor; see WndEditor for details.

Reimplemented from GG::Control.

virtual void GG::Scroll::LButtonDown ( const Pt pt,
Flags< ModKey >  mod_keys 
) [protected, virtual]

Respond to left button down msg. A window receives this whenever any input device button changes from up to down while over the window.

Note:
If this Wnd was created with the REPEAT_BUTTON_DOWN flag, this method may be called multiple times during a single button press-release cycle.
See also:
GG::GUI

Reimplemented from GG::Wnd.

virtual void GG::Scroll::LButtonUp ( const Pt pt,
Flags< ModKey >  mod_keys 
) [protected, virtual]

Respond to release of left mouse button outside this Wnd, if it was originally depressed over this Wnd. A Wnd will receive an LButtonUp() message whenever a drag that started over its area ends, even if the cursor is not currently over the window when this happens.

Reimplemented from GG::Wnd.

virtual void GG::Scroll::LClick ( const Pt pt,
Flags< ModKey >  mod_keys 
) [protected, virtual]

Respond to release of left mouse button over this Wnd, if it was also originally depressed over this Wnd. A Wnd will receive an LButtonUp() message whenever a drag that started over its area ends over its area as well.

Reimplemented from GG::Wnd.

virtual void GG::Scroll::MouseHere ( const Pt pt,
Flags< ModKey >  mod_keys 
) [protected, virtual]

Respond to cursor moving about within the Wnd, or to cursor lingering within the Wnd for a long period of time. A MouseHere() message will not be generated the first time the cursor enters the window's area. In that case, a MouseEnter() message is generated.

Reimplemented from GG::Wnd.

virtual bool GG::Scroll::EventFilter ( Wnd w,
const WndEvent event 
) [protected, virtual]

Handles an WndEvent destined for Wnd w, but which this Wnd is allowed to handle first. Returns true if this filter processed the message.

Reimplemented from GG::Wnd.


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