Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_M_SubViewHandler Class Reference
[UI]

Mix-in class for UI elements that can contain sub views. More...

Inheritance diagram for CP_M_SubViewHandler:

CP_View CP_BackgroundView CP_FocusBorder CP_LittleArrowsEditBuddy CP_OpenGLView CP_PlatformControl CP_PrintView CP_QT_MovieView CP_ScrollableView CP_Scroller CP_SelectColorButton CP_Splitter CP_TextView CP_Toolbar CP_Window_Imp CP_Window_Imp CP_Window_Imp List of all members.

Public Member Functions

Constructor / Destructor
virtual ~CP_M_SubViewHandler ()
 Destructor.

Protected Member Functions

Constructor / Destructor
 CP_M_SubViewHandler ()
 Constructor.

Protected Attributes

CP_SubViews_ListfSubViews

Detailed Description


Constructor & Destructor Documentation

CP_M_SubViewHandler::~CP_M_SubViewHandler  )  [virtual]
 

Destructor.

Exceptions:
none 

CPLAT_Begin_Namespace_CPLAT CP_M_SubViewHandler::CP_M_SubViewHandler  )  [protected]
 

Constructor.

Exceptions:
none 


Member Function Documentation

void CP_M_SubViewHandler::AddSubviewToList CP_View inSubView  ) 
 

Adds the passed in subView to our list of subViews. If the View is already in the list, it is not added another time.

Parameters:
inSubView The CP_View object being added.
Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::DeleteSubViews  )  [virtual]
 

Delete all of our sub Views and the list that tracks them.

Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::DeleteSubView CP_View inSubView,
bool  inDeleteSubViews = true,
bool  inDeleteSubView = true
[virtual]
 

Delete one of our subViews.

Parameters:
inSubView The CP_View object to delete.
inDeleteSubViews Flag to indicate if the subView is a view, should it delete its subViews.
inDeleteSubView Flag to indicate if the subView is just removed from our list, or removed and the passed in object then deleted.
Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::RemoveSubView CP_View inSubView  ) 
 

Remove the passed in subView from our list of subViews.

Parameters:
inSubView The CP_View to be removed.
Exceptions:
none 
Returns:
void

CP_View * CP_M_SubViewHandler::FindSubView const CP_Point inWhere,
bool  inRecrusive = kCP_NoRecrusiveSearch
 

Find the sub View containing our passed in point. The search beings at the end of the list of subViews. The subView list is in order that the subViews where added to the view, not necessarily by location.

Parameters:
inWhere The location of the subView we are after.
inRecrusive Flag to indicate if we should find the deepest subView containing the point.
Exceptions:
none 
Returns:
void

CP_View * CP_M_SubViewHandler::FindSubView const UInt32  inViewID,
bool  inRecrusive = kCP_NoRecrusiveSearch
 

Find the sub View containing our passed in View id. The search beings at the end of the list of subViews. The subView list is in order that the subViews where added to the view, not necessarily by location. This will return the last subView added with the passed in id in case of multiple subViews with the same id.

Parameters:
inViewID The View ID of the subView we are after.
inRecrusive Flag to indicate if we should find the deepest subView containing the point.
Exceptions:
none 
Returns:
void

bool CP_M_SubViewHandler::ContainsSubView CP_View inView,
bool  inRecrusive
 

Returns true if this subview contains the passed in CP_View object. If the inRecrusive flag is set and the view is not found in the outter view, the search continues in subviews until the match is found, or all views and sub views have been searched.

Parameters:
inView The view we are after.
inRecrusive Flag to indicate if we should find the deepest subView containing the point.
Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::ShowSubs  )  [protected, virtual]
 

Show the window.

Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::HideSubs  )  [protected, virtual]
 

Hide the window.

Exceptions:
none 
Returns:
void


Member Data Documentation

CP_SubViews_List* CP_M_SubViewHandler::fSubViews [protected]
 


The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:49 2005 for CPLAT by  doxygen 1.4.0