Overview   Project   Class   Tree   Deprecated   Index 
0 A.D.
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

ps
Class AbstractProfileTable

   in ProfileViewer.h
   in ProfileViewer.cpp
Direct Known Subclasses:
CProfileNodeTable, CRendererStatsTable

class AbstractProfileTable

Class AbstractProfileTable: Profile table data model. Clients that wish to display debug information in the profile viewer have to implement this class and hook it into CProfileViewer. Note that the profiling system is robust against deletion of object instances in the sense that it will automatically remove an AbstractProfileTable instance from its internal records when you delete it. Conversely, deleting an AbstractProfileTable instance is the responsibility of its creator.


Constructor Summary
virtual ~AbstractProfileTable()
          CProfileViewer implementation
 
Method Summary
 virtual CStr GetCellText( size_t row, size_t col )= 0
          GetCellText
 virtual AbstractProfileTable* GetChild( size_t row )= 0
          GetChild: Return a row's child table if the child is expandable.
 virtual const std::vector< ProfileColumn >& GetColumns()= 0
          GetColumnDescriptions
 virtual CStr GetName()= 0
          GetName: Short descriptive name of this table (should be static).
 virtual size_t GetNumberRows()= 0
          GetNumberRows
 virtual CStr GetTitle()= 0
          GetTitle: Longer, explanatory text (can be dynamic).
 virtual bool IsHighlightRow( size_t row )
          IsHighlightRow
 

Constructor Detail

~AbstractProfileTable

public virtual ~AbstractProfileTable();
CProfileViewer implementation


Method Detail

GetCellText

public virtual CStr GetCellText( size_t row, size_t col )= 0;
GetCellText
Parameters:
row - Row index (the first row has index 0).
col - Column index (the first column has index 0).
Returns:
Text to be displayed in the given cell.

GetChild

public virtual AbstractProfileTable* GetChild( size_t row )= 0;
GetChild: Return a row's child table if the child is expandable.
Parameters:
row - Row index (the first row has index 0).
Returns:
Pointer to the child table if the given row has one. Otherwise, return 0.

GetColumns

public virtual const std::vector< ProfileColumn >& GetColumns()= 0;
GetColumnDescriptions
Returns:
A vector describing all columns of the table.

GetName

public virtual CStr GetName()= 0;
GetName: Short descriptive name of this table (should be static).
Returns:
Descriptive name of this table.

GetNumberRows

public virtual size_t GetNumberRows()= 0;
GetNumberRows
Returns:
Number of rows in this table.

GetTitle

public virtual CStr GetTitle()= 0;
GetTitle: Longer, explanatory text (can be dynamic).
Returns:
Title for the table.

IsHighlightRow

public virtual bool IsHighlightRow( size_t row );
IsHighlightRow
Parameters:
row - Row index (the first row has index 0).
Returns:
true if the row should be highlighted in a special color.

 Overview   Project   Class   Tree   Deprecated   Index 
0 A.D.
Generated on September 04, 2007 at 18:13
CppDoc v2.4.0
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD