MFC Grid manual

CGridLine Class Reference

Line-related paint information. More...

#include <Dapfor/GUI/GridLine.h>

List of all members.


Public Member Functions

 CGridLine (const CPaintInfo &paintInfo, ContextType contextType, int row, HITEM item, bool isPreviusRowSelected, bool isNextRowSelected)
 Constructor.
 CGridLine (const CGridLine &line)
 Copy constructor.
const CPaintInfo & GetPaintInfo () const
 Gets paint info.
CPaintInfo & GetPaintInfo ()
 Gets paint info. Const version.
ContextType GetContextType () const
 Gets a context type where the data object was inserted.
int GetRow () const
 Gets a zero-based index in the specified context.
HITEM GetItem () const
 Gets an item handle.
bool IsRowSelected () const
 Indicates whether a line is selected.
bool IsPreviusRowSelected () const
 Indicates whether the previous line is selected.
bool IsNextRowSelected () const
 Indicates whether the next line is selected.
long GetHierarchicalLevel () const
 Gets a zero-based level of the line in the hierarchy.
bool IsExpanded () const
 Indicates whether a line is expanded.
const Common::CDataObject * GetDataObject () const
 Returns the related data object.

Detailed Description

Line-related paint information.

Version:
1.0.0.0 Initial version

Constructor & Destructor Documentation

CGridLine ( const CPaintInfo &  paintInfo,
ContextType  contextType,
int  row,
HITEM  item,
bool  isPreviusRowSelected,
bool  isNextRowSelected 
)

Constructor.

Parameters:
[in] paintInfo Contains colors, rectangles, font, text adjustement to draw a cell
[in] contextType Context type. Possible value: FixedContext, ScrollableContext
[in] row Zero-based index in the context
[in] item Item handle
[in] isPreviusRowSelected Indicates whether the previous line is selected
[in] isNextRowSelected Indicates whether the next line is selected

CGridLine ( const CGridLine &  line  ) 

Copy constructor.

Parameters:
[in] line A line to be copied

Member Function Documentation

const CPaintInfo & GetPaintInfo (  )  const [inline]

Gets paint info.

Returns:
Paint information like colors, rectangles, font, text adjustement etc...

CPaintInfo & GetPaintInfo (  )  [inline]

Gets paint info. Const version.

Returns:
Paint information like colors, rectangles, font, text adjustement etc...

ContextType GetContextType (  )  const [inline]

Gets a context type where the data object was inserted.

Returns:
Context type

int GetRow (  )  const [inline]

Gets a zero-based index in the specified context.

Returns:
Zero-based index in the context

HITEM GetItem (  )  const [inline]

Gets an item handle.

Returns:
Item handle. If the line doesn't contain an underlying data object, the function returns zero.

bool IsRowSelected (  )  const

Indicates whether a line is selected.

Returns:
True if selected. Otherwise false.

bool IsPreviusRowSelected (  )  const [inline]

Indicates whether the previous line is selected.

Returns:
True if selected. Otherwise false.

bool IsNextRowSelected (  )  const [inline]

Indicates whether the next line is selected.

Returns:
True if selected. Otherwise false.

long GetHierarchicalLevel (  )  const

Gets a zero-based level of the line in the hierarchy.

Returns:
Zero-based hierarchical level. If the line doesn't contain a data object, the function returns zero.

bool IsExpanded (  )  const

Indicates whether a line is expanded.

Returns:
True if expanded. Otherwise false.

const Common::CDataObject * GetDataObject (  )  const

Returns the related data object.

Returns:
Pointer to the data object. The value can be zero, if the line is empty i.e. doesn't have an underlying data object