GG::ZList Class Reference

a Z-ordering (depth-ordering) of the windows in the GUI. More...

#include <ZList.h>

List of all members.

Accessors

WndPick (const Pt &pt, Wnd *modal, Wnd *ignore=0) const

Mutators

void Add (Wnd *wnd)
bool Remove (Wnd *wnd)
bool MoveUp (Wnd *wnd)
bool MoveDown (Wnd *wnd)


Detailed Description

a Z-ordering (depth-ordering) of the windows in the GUI.

Windows being moved up, inserted, or added to the top of the list are checked against other windows at the insertion point and after; if any of these windows are modal or on-top windows, the inserted window is placed after them if it is not also modal or on-top. Z-values decrease into the screen. Windows in the z-list are kept in front-to-back order. No windows may share the same z-value. Add, Remove, MoveUp, and MoveDown all also add/remove/move all descendent windows.

Definition at line 46 of file ZList.h.


Member Function Documentation

Wnd* GG::ZList::Pick ( const Pt pt,
Wnd modal,
Wnd ignore = 0 
) const

returns pointer to the window under the point pt; constrains pick to modal if nonzero, and ignores ignore if nonzero

void GG::ZList::Add ( Wnd wnd  ) 

Add() places wnd in the list in front of the first entry with z-value <= wnd->ZOrder(), or at the end of the list, whichever comes first.

If wnd->ZOrder() == 0, Add() inserts wnd at the front of the list, and updates wnd's z-value.

bool GG::ZList::Remove ( Wnd wnd  ) 

removes wnd from z-order

bool GG::ZList::MoveUp ( Wnd wnd  ) 

moves wnd from its current position to the beginning of list; updates wnd's z-value

bool GG::ZList::MoveDown ( Wnd wnd  ) 

moves wnd from its current position to the end of list; updates wnd's z-value


The documentation for this class was generated from the following file:
Generated on Wed Mar 26 14:35:43 2008 for GG by  doxygen 1.5.2