Views
Gadgets Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvMatrixLFHandler Class Referenceabstract

Object Look-and-Feel class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvMatrixLFHandler:
IlvObjectLFHandler IlvDefaultMatrixLFHandler IlvMatrixCSSLFHandler IlvMatrixMLFHandler IlvMatrixWLFHandler IlvMatrixVXLFHandler IlvMatrixW95LFHandler

Public Member Functions

 IlvMatrixLFHandler (IlvLookFeelHandler *lfh)
 Constructor. More...
 
virtual void drawBackground (const IlvMatrix *matrix, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the background of a matrix. More...
 
virtual void drawFrame (const IlvMatrix *matrix, IlvPort *dst, const IlvTransformer *t, const IlvRegion *clip) const =0
 Is called to draw the frame of a matrix. More...
 
virtual void drawItem (const IlvMatrix *matrix, IlvPort *dst, IlUShort colno, IlUShort rowno, const IlvRect &itembbox, const IlvRect &clip) const =0
 Is called to draw a matrix item. More...
 
virtual void drawRelief (const IlvMatrix *matrix, IlUShort colno, IlUShort rowno, IlvPort *dst, const IlvRect &rect, const IlvRect *clip) const =0
 Is called to draw the relief of a matrix item. More...
 
virtual void drawSelection (const IlvMatrix *matrix, IlvPort *dst, const IlvRect &rect, const IlvRect *clip) const =0
 Is called to draw the selection of a matrix item. More...
 
virtual const IlvPalettegetInsensitivePalette (const IlvMatrix *, const IlvAbstractMatrixItem *item) const =0
 Returns the palette used to draw the selection in the matrix. More...
 
virtual const IlvPalettegetReliefPalette (const IlvMatrix *, const IlvAbstractMatrixItem *item) const =0
 Returns the palette used to draw the relief in the matrix. More...
 
virtual const IlvPalettegetSelectionPalette (const IlvMatrix *matrix, const IlvAbstractMatrixItem *item) const =0
 Returns the palette used to draw the selection in the matrix. More...
 
virtual const IlvPalettegetTextPalette (const IlvMatrix *, const IlvAbstractMatrixItem *item) const =0
 Returns the palette used to draw the text in the matrix. More...
 
virtual const IlvPalettegetWindowBackground (const IlvMatrix *matrix) const =0
 Returns the palette used to draw the background of the matrix. More...
 
virtual IlBoolean handleMatrixEvent (IlvMatrix *matrix, IlvEvent &event) const =0
 Is called to handle the events of a matrix. More...
 
virtual void itemBBox (const IlvMatrix *matrix, IlUShort col, IlUShort row, IlvRect &r, const IlvTransformer *t) const =0
 Calculates matrix item bounding box. More...
 
virtual const IlvPalettestylePalette (const IlvPalette *base, const IlvMatrix *matrix, const IlvAbstractMatrixItem *item) const =0
 Adds look and feel styling to a palette. CSS look and feel specific, allows different style for each matrix item. Classic look and feel handlers return the palette unmodified. More...
 

Detailed Description

Object Look-and-Feel class.

Library: ilvadvgdt

The base class for the object look-and-feel handlers of the matrix gadget.

Constructor & Destructor Documentation

◆ IlvMatrixLFHandler()

IlvMatrixLFHandler::IlvMatrixLFHandler ( IlvLookFeelHandler lfh)

Constructor.

Creates a new IlvMatrixLFHandler instance and initializes it with lfh.

Parameters
lfhThe look-and-feel handler which this handler will be associated to.

Member Function Documentation

◆ drawBackground()

virtual void IlvMatrixLFHandler::drawBackground ( const IlvMatrix matrix,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the background of a matrix.

Parameters
matrixThe matrix.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultMatrixLFHandler.

◆ drawFrame()

virtual void IlvMatrixLFHandler::drawFrame ( const IlvMatrix matrix,
IlvPort dst,
const IlvTransformer t,
const IlvRegion clip 
) const
pure virtual

Is called to draw the frame of a matrix.

Parameters
matrixThe matrix.
dstThe destination port.
tThe transformer.
clipThe clipping region.

Implemented in IlvDefaultMatrixLFHandler.

◆ drawItem()

virtual void IlvMatrixLFHandler::drawItem ( const IlvMatrix matrix,
IlvPort dst,
IlUShort  colno,
IlUShort  rowno,
const IlvRect itembbox,
const IlvRect clip 
) const
pure virtual

Is called to draw a matrix item.

Parameters
matrixThe matrix.
dstThe destination port.
colnoThe column number.
rownoThe row number.
itembboxThe rectangle where to draw the item.
clipThe clipping rectangle.

Implemented in IlvMatrixCSSLFHandler, and IlvDefaultMatrixLFHandler.

◆ drawRelief()

virtual void IlvMatrixLFHandler::drawRelief ( const IlvMatrix matrix,
IlUShort  colno,
IlUShort  rowno,
IlvPort dst,
const IlvRect rect,
const IlvRect clip 
) const
pure virtual

Is called to draw the relief of a matrix item.

Parameters
matrixThe matrix.
colnoThe column number.
rownoThe row number.
dstThe destination port.
rectThe rectangle where to draw the relief.
clipThe clipping rectangle.

Implemented in IlvMatrixWLFHandler, IlvMatrixW95LFHandler, IlvMatrixVXLFHandler, IlvMatrixMLFHandler, and IlvMatrixCSSLFHandler.

◆ drawSelection()

virtual void IlvMatrixLFHandler::drawSelection ( const IlvMatrix matrix,
IlvPort dst,
const IlvRect rect,
const IlvRect clip 
) const
pure virtual

Is called to draw the selection of a matrix item.

Parameters
matrixThe matrix.
dstThe destination port.
rectThe rectangle where to draw the selection.
clipThe clipping rectangle.

Implemented in IlvMatrixWLFHandler, IlvMatrixMLFHandler, and IlvMatrixCSSLFHandler.

◆ getInsensitivePalette()

virtual const IlvPalette* IlvMatrixLFHandler::getInsensitivePalette ( const IlvMatrix ,
const IlvAbstractMatrixItem item 
) const
pure virtual

Returns the palette used to draw the selection in the matrix.

Parameters
matrixThe matrix.
itemMatrix item that the palette is used for. CSS look and feel specific, allows different style for each item. if set null, matrix style is used. Classic look and feel handlers ignore the parameter.
Returns
IlvPalette used to draw the relief in the matrix.

Implemented in IlvMatrixCSSLFHandler, and IlvDefaultMatrixLFHandler.

◆ getReliefPalette()

virtual const IlvPalette* IlvMatrixLFHandler::getReliefPalette ( const IlvMatrix ,
const IlvAbstractMatrixItem item 
) const
pure virtual

Returns the palette used to draw the relief in the matrix.

Parameters
matrixThe matrix.
itemMatrix item that the palette is used for. CSS look and feel specific, allows different style for each item. if set null, matrix style is used. Classic look and feel handlers ignore the parameter.
Returns
IlvPalette used to draw the relief in the matrix.

Implemented in IlvMatrixCSSLFHandler, and IlvDefaultMatrixLFHandler.

◆ getSelectionPalette()

virtual const IlvPalette* IlvMatrixLFHandler::getSelectionPalette ( const IlvMatrix matrix,
const IlvAbstractMatrixItem item 
) const
pure virtual

Returns the palette used to draw the selection in the matrix.

Parameters
matrixThe matrix.
itemMatrix item that the palette is used for. CSS look and feel specific, allows different style for each item. if set null, matrix style is used. Classic look and feel handlers ignore the parameter.
Returns
IlvPalette used to draw the selection in the matrix.

Implemented in IlvMatrixCSSLFHandler, IlvMatrixWLFHandler, and IlvMatrixMLFHandler.

◆ getTextPalette()

virtual const IlvPalette* IlvMatrixLFHandler::getTextPalette ( const IlvMatrix ,
const IlvAbstractMatrixItem item 
) const
pure virtual

Returns the palette used to draw the text in the matrix.

Parameters
matrixThe matrix.
itemMatrix item that the palette is used for. CSS look and feel specific, allows different style for each item. if set null, matrix style is used. Classic look and feel handlers ignore the parameter.
Returns
IlvPalette used to draw the text in the matrix.

Implemented in IlvMatrixCSSLFHandler, IlvMatrixWLFHandler, and IlvMatrixMLFHandler.

◆ getWindowBackground()

virtual const IlvPalette* IlvMatrixLFHandler::getWindowBackground ( const IlvMatrix matrix) const
pure virtual

Returns the palette used to draw the background of the matrix.

Parameters
matrixThe matrix.
Returns
The palette used to draw the background of the matrix.

Implemented in IlvDefaultMatrixLFHandler.

◆ handleMatrixEvent()

virtual IlBoolean IlvMatrixLFHandler::handleMatrixEvent ( IlvMatrix matrix,
IlvEvent event 
) const
pure virtual

Is called to handle the events of a matrix.

Parameters
matrixThe matrix.
eventThe event to handle.
Returns
IlTrue if the event has been consumed.

Implemented in IlvDefaultMatrixLFHandler.

◆ itemBBox()

virtual void IlvMatrixLFHandler::itemBBox ( const IlvMatrix matrix,
IlUShort  col,
IlUShort  row,
IlvRect r,
const IlvTransformer t 
) const
pure virtual

Calculates matrix item bounding box.

Parameters
matrixThe matrix.
colColumn
rowRow
rRect of item bbox
tTransformer

Implemented in IlvDefaultMatrixLFHandler, and IlvMatrixCSSLFHandler.

◆ stylePalette()

virtual const IlvPalette* IlvMatrixLFHandler::stylePalette ( const IlvPalette base,
const IlvMatrix matrix,
const IlvAbstractMatrixItem item 
) const
pure virtual

Adds look and feel styling to a palette. CSS look and feel specific, allows different style for each matrix item. Classic look and feel handlers return the palette unmodified.

Parameters
baseThe palette that will be used as a base (default)
matrixThe matrix.
itemMatrix item that the palette is used for.
Returns
IlvPalette with styling.

Implemented in IlvMatrixCSSLFHandler, and IlvDefaultMatrixLFHandler.