Class CGridLabelImg

class CGridLabelImg : public CBase;

Description

Draws a grid cell's label.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CGridLabelImg - Draws a grid cell's label.

Members

Defined in CGridLabelImg:

• CGridLabelImg(const TFontSpec &,MGraphicsDeviceMap *)Constructor taking specified parameters.
• ConstructL()Implements the second phase of two-phase construction.
• DrawColLabelL(CGraphicsContext *,TInt,const TRect &)constDraws a column label.
• DrawRowCursorL(CGraphicsContext *,const TRect &)constDraws a cursor to identify a row.
• DrawRowLabelL(CGraphicsContext *,TInt,const TRect &)constDraws a row label.
• DrawTopLeftLabelL(CGraphicsContext *,const TRect &)constFills the specified rectangle with a colour.
• DrawTopLeftLabelL(CGraphicsContext *,const TRect &,TRgb)constFills the specified rectangle with the specified colour.
• EDefaultSideLabelWidthInTwipsThe default width of side labels, in twips.
• EDefaultTopLabelHeightInTwipsThe default height of top labels, in twips.
• FontSpec()constGets the font specification.
• NotifyGraphicsDeviceMapChangeL()Deals with the result of changing the graphics device map, i.e. the interface fo...
• ReleaseFont()Releases the font.
• SetGraphicsDeviceMap(MGraphicsDeviceMap *)Supplies a new interface object for mapping between twips and device-specific un...
• SetGridColors(const TGridColors &)Sets the colours to be used when drawing the label.
• SideLabelWidthInPixels(TInt,TInt)constGets the width of the side labels.
• TopLabelHeightInPixels()constGets the height of the top labels.
• anonymous
• iFontThe nearest font to that specified in the font specification.
• iFontSpecThe font specification in device independent terms.
• iGraphicsDeviceMapThe graphics device map, an interface for mapping between twips and device-speci...
• iGridColorsThe grid colour specification.
• ~CGridLabelImg()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C virtual ~CGridLabelImg();

Description

Destructor.

Releases resources before the object is destroyed. Specifically, it releases the font acquired when the object was constructed.

IMPORT_C void ConstructL();

Description

Implements the second phase of two-phase construction.

Specifically, it gets the nearest font to that specified in the font specification passed to the constructor.

protected: IMPORT_C CGridLabelImg(const TFontSpec &aFontSpec, MGraphicsDeviceMap *aGraphicsDeviceMap);

Description

Constructor taking specified parameters.

Parameters

inline void SetGraphicsDeviceMap(MGraphicsDeviceMap *aGraphicsDeviceMap);

Description

Supplies a new interface object for mapping between twips and device-specific units.

Note that the caller must call CGridLabelImg::ReleaseFont() before calling this function, and must call CGridLabelImg::NotifyGraphicsDeviceMapChangeL() afterwards.

Parameters

inline TFontSpec FontSpec() const;

Description

Gets the font specification.

Return value

IMPORT_C void ReleaseFont();

Description

Releases the font.

This is called by the destructor, and should be called before calling CGridLabelImg::SetGraphicsDeviceMap(MGraphicsDeviceMap *).

See also:

• CGridLabelImg::ConstructL()Implements the second phase of two-phase construction.

IMPORT_C void NotifyGraphicsDeviceMapChangeL();

Description

Deals with the result of changing the graphics device map, i.e. the interface for mapping between twips and device-specific units.

The function releases the existing font, and then tries to get the nearest font to that specified in the font specification.

See also:

• CGridLabelImg::ConstructL()Implements the second phase of two-phase construction.
• CGridLabelImg::SetGraphicsDeviceMap(MGraphicsDeviceMap *)Supplies a new interface object for mapping between twips and device-specific un...

inline void SetGridColors(const TGridColors &aGridColors);

Description

Sets the colours to be used when drawing the label.

Parameters

protected: IMPORT_C void DrawTopLeftLabelL(CGraphicsContext *aGc, const TRect &aRect, TRgb aColor) const;

Description

Fills the specified rectangle with the specified colour.

Parameters

private: virtual void DrawRowLabelL(CGraphicsContext *aGc, TInt aRow, const TRect &aRect) const=0;

Description

Draws a row label.

Parameters

private: virtual void DrawColLabelL(CGraphicsContext *aGc, TInt aCol, const TRect &aRect) const=0;

Description

Draws a column label.

Parameters

private: IMPORT_C virtual void DrawTopLeftLabelL(CGraphicsContext *aGc, const TRect &aRect) const;

Description

Fills the specified rectangle with a colour.

The default implementation fills the specified rectangle with the background colour value as defined by the grid colour specification in iGridColors.

Parameters

See also:

• TGridColorsThe grid colour specification.

private: IMPORT_C virtual TInt SideLabelWidthInPixels(TInt aStartRow, TInt aEndRow) const;

Description

Gets the width of the side labels.

Parameters

Return value

private: IMPORT_C virtual TInt TopLabelHeightInPixels() const;

Description

Gets the height of the top labels.

Return value

private: IMPORT_C virtual void DrawRowCursorL(CGraphicsContext *aGc, const TRect &aRect) const;

Description

Draws a cursor to identify a row.

The default implementation is empty.

Parameters

protected: n/a

Description

protected: CFont * iFont;

Description

The nearest font to that specified in the font specification.

protected: TFontSpec iFontSpec;

Description

The font specification in device independent terms.

protected: MGraphicsDeviceMap * iGraphicsDeviceMap;

Description

The graphics device map, an interface for mapping between twips and device-specific units.

protected: TGridColors iGridColors;

Description

The grid colour specification.