ICS

QicsTable Documentation Set

QicsNoWidgetCellDisplay Class Reference

Abstract class for cell display objects with a single entry widget. More...

#include <QicsCellDisplay.h>

Inherits QicsCellDisplay.

List of all members.

Public Types

enum  QicsSortMode { QicsStableSort = 0, QicsQuickSort }
enum  QicsCellOverflowBehavior { Clip = 0, Overflow, ToolTip }
enum  QicsCurrentCellStyle { Spreadsheet = 0, NormalSelected }
enum  QicsGridCellClipping { AllowPartial = 0, NoDisplayOnPartial, UseClippedSymbol }
enum  QicsGridType { TableGrid = 0, RowHeaderGrid, ColumnHeaderGrid }
enum  QicsHeaderType { RowHeader = 0, ColumnHeader }
enum  QicsIndexType { RowIndex, ColumnIndex }
enum  QicsLineStyle { None = 0, Plain, Raised, Sunken }
enum  QicsRepaintBehavior { RepaintOff = 0, RepaintOn = 1, RepaintCalcOnly = 2 }
enum  QicsScrollBarMode { Auto = 0, AlwaysOff, AlwaysOn }
enum  QicsScrollDirection {
  ScrollNone = 0, ScrollUp, ScrollDown, ScrollLeft,
  ScrollRight, ScrollToRow, ScrollToColumn
}
enum  QicsSelectionPolicy {
  SelectNone = 0, SelectSingle, SelectMultiple, SelectSingleRow,
  SelectMultipleRow
}
enum  QicsSelectionType {
  SelectionNone = 0, SelectionBegin, SelectionDrag, SelectionEnd,
  SelectionExtend, SelectionAdd
}
enum  QicsSortOrder { Ascending = 0, Descending }
enum  QicsTableDisplayOption { DisplayNever = 0, DisplayAlways, DisplayFirstPage }
enum  QicsTraversalKeyEditBehavior { TraverseWithinCell = 0, TraverseBetweenCells }

Public Member Functions

 QicsNoWidgetCellDisplay ()
virtual ~QicsNoWidgetCellDisplay ()
virtual void startEdit (QicsScreenGrid *, int row, int col, const QicsDataItem *)
virtual void moveEdit (QicsScreenGrid *, int row, int col, const QRect &rect)
virtual void endEdit (QicsScreenGrid *grid, int row, int col)
virtual void hideEdit (QicsScreenGrid *)
virtual bool editWhenCurrent (void) const
virtual void displayCell (QicsGrid *grid, int row, int col, const QicsDataItem *itm, QRect &rect, QPainter *painter)=0
virtual bool handleMouseEvent (QicsScreenGrid *grid, int row, int col, QMouseEvent *me)
virtual bool handleKeyEvent (QicsScreenGrid *grid, int row, int col, QKeyEvent *ke)
virtual QSize sizeHint (QicsGrid *grid, int row, int col, const QicsDataItem *itm)=0
virtual bool needsVisibilityNotification (void) const
virtual bool isEmpty (QicsGridInfo *info, int row, int col, const QicsDataItem *itm) const =0
virtual QString tooltipText (QicsGridInfo *info, int row, int col, const QicsDataItem *itm, const QRect &rect) const

Protected Member Functions

virtual void drawBackground (QicsGridInfo *info, int row, int col, const QRect &rect, const QPalette &pal, QPainter *painter, bool is_current=false, bool is_selected=false)
virtual void drawBorder (QicsGridInfo *info, int row, int col, const QRect &rect, const QPalette &pal, QPainter *painter, bool is_current=false, bool is_selected=false)
virtual bool isCellSelected (QicsGridInfo *info, int row, int col)
virtual QPalette cellPalette (QicsGridInfo *info, int row, int col, bool for_printer=false)
virtual QRect displayableCellArea (QicsGridInfo *ginfo, int row, int col, const QRect &cr_full, bool consider_margin=true, bool consider_border=true) const

Protected Attributes

QPointer< QicsCellmyCell
QPointer< QicsRowmyRow
QPointer< QicsColumnmyColumn
QPointer< QicsMainGridmyGrid


Detailed Description

Abstract class for cell display objects with a single entry widget.

QicsNoWidgetCellDisplay is an abstract class that implements portions of the interface defined by QicsCellDisplay. QicsNoWidgetCellDisplay contains internal methods and data to help implement a cell display class that handles all aspects of the cell, including any editing and user interaction, as well as the actual drawing of cell contents.

See Customizing Table Display Using Cell Display Objects for more information on creating a cell display class.


Member Enumeration Documentation

enum Qics::QicsCellOverflowBehavior [inherited]
 

Denotes the behavior of grids when handling cells whose contents cannot be displayed in the boundaries of the cell.

  • Clip Cell contents are clipped at the edges of the cell
  • Overflow The grid will attempt to overflow into adjacent cells
  • ToolTip The full contents of the cell will be displayed in a tooltip when the mouse pointer is hovered over the cell

enum Qics::QicsCurrentCellStyle [inherited]
 

Denotes the visual style that the current cell of the table will be drawn with.

  • Spreadsheet The current cell will be drawn with a solid border and will always use the cell's background color.
  • NormalSelected The current cell will be drawn the same as all other selected cells. The border will be as specified in the cell's border properties, and the background will be the cell's selected color.

enum Qics::QicsGridCellClipping [inherited]
 

Denotes the policy for displaying text that is too long to fit in its cell

  • AllowPartial Shows as much of the text as possible
  • NoDisplayOnPartial Do not display text if it cannot fit in the cell
  • UseClippedSymbol Display a clipped symbol at the end of the partial text

enum Qics::QicsGridType [inherited]
 

Specifies a type of grid object.

  • TableGrid A grid used to display normal table data
  • RowHeaderGrid A grid used to display row header data
  • ColumnHeaderGrid A grid used to display column header data

enum Qics::QicsHeaderType [inherited]
 

Specifies the type of table header.

  • HeaderRow A row header
  • HeaderColumn A column header

enum Qics::QicsIndexType [inherited]
 

Specifies the type of table index.

  • RowIndex A row index
  • ColumnIndex A column index

enum Qics::QicsLineStyle [inherited]
 

Denotes the style of lines and borders in the table widget.

  • None No line or border
  • Plain A simple, plain line or border
  • Raised A raised line (using shadows)
  • Sunken A sunken line (using shadows)

enum Qics::QicsRepaintBehavior [inherited]
 

Specifies the recalculation and repainting behavior of tables and grids.

  • RepaintOff Do not perform any drawing or dimension calculations
  • RepaintOn Draw as needed, keep all dimensions up to date
  • RepaintCalcOnly Do not draw, but keep all dimensions up to date

enum Qics::QicsScrollBarMode [inherited]
 

Specifies the various modes of QicsTable's scroll bars.

  • Auto QicsTable shows a scroll bar when the content is too large to fit and not otherwise.
  • AlwaysOff QicsTable never shows a scroll bar.
  • AlwaysOn QicsTable always shows a scroll bar.

enum Qics::QicsScrollDirection [inherited]
 

Denotes a direction for scrolling operations, or that an absolute scroll should occur.

  • ScrollNone no scroll allowed
  • ScrollUp scrolling up on a certain number of rows
  • ScrollDown scrolling down on a certain number of rows
  • ScrollLeft scrolling left on a certain number of columns
  • ScrollRight scrolling right on a certain number of columns
  • ScrollToRow scrolling up or down to a certain row
  • ScrollToColumn scrolling left or right to a certain column

enum Qics::QicsSelectionPolicy [inherited]
 

Denotes the selection policy for the table.

  • SelectNone no selection allowed
  • SelectSingle single cell selection
  • SelectionMultiple multiple cell selection (including non-contiguous regions)
  • SelectSingleRow selecting a cell selects the entire row, only one row can be selected
  • SelectMultipleRow selecting a cell selects the entire row, multiple rows can be selected

enum Qics::QicsSortMode [inherited]
 

Denotes the sort algorithm which is used

  • QicsStableSort Used non distructive, stable sort algorithm
  • QicsQuickSort Default quick sort algorithm.

enum Qics::QicsSortOrder [inherited]
 

Specifies whenever ordering should be ascending or descending.

  • Ascending Ascending order
  • Descending Descending order

enum Qics::QicsTableDisplayOption [inherited]
 

Specifies a printing display policy for elements of the table

  • DisplayNever Do not display the element when printing
  • DisplayAlways Always display the element when printing
  • DisplayFirstPage Display the element only when printing the first page of the table

enum Qics::QicsTraversalKeyEditBehavior [inherited]
 

Specifies the behavior of the traversal keys (left, right, up, down, etc) while editing a cell.

  • TraverseWithinCell Traversal keys move the text cursor within the edited cell.
  • TraverseBetweenCells Traversal keys move the current cell highlight between cells in the table.


Constructor & Destructor Documentation

QicsNoWidgetCellDisplay::QicsNoWidgetCellDisplay  ) 
 

Constructor for the abstract class. Should never be called by the programmer. This is intended only for use by subclass constructors.

virtual QicsNoWidgetCellDisplay::~QicsNoWidgetCellDisplay  )  [virtual]
 

Destructor for the class.


Member Function Documentation

virtual QPalette QicsCellDisplay::cellPalette QicsGridInfo info,
int  row,
int  col,
bool  for_printer = false
[protected, virtual, inherited]
 

Returns the palette to be used when drawing in cell (row, col ), using grid information from info. If for_printer is true, the palette will have a white background color substituted for any background colors that are the same as the default background color of the grid.

Parameters:
info grid info object
row the row in visual coordinates
col the column in visual coordinates
for_printer will this palette be used to print?

Reimplemented in QicsComboCellDisplay.

virtual QRect QicsCellDisplay::displayableCellArea QicsGridInfo ginfo,
int  row,
int  col,
const QRect &  cr_full,
bool  consider_margin = true,
bool  consider_border = true
const [protected, virtual, inherited]
 

Returns a rectangle specifying the area of cell (row, col ) that can be used to display information. This rectangle is based on the full area of the cell (contained in cr_full ), minus the area reserved for the cell's border and margin.

Parameters:
info grid info object
row the row in visual coordinates
col the column in visual coordinates
cr_full the full area of the cell
consider_margin should the returned area exclude the margin of the cell?
consider_border should the returned area exclude the border of the cell?

virtual void QicsCellDisplay::displayCell QicsGrid grid,
int  row,
int  col,
const QicsDataItem itm,
QRect &  rect,
QPainter *  painter
[pure virtual, inherited]
 

Displays the cell (row, col ) in grid widget grid. The cell will be displayed in region rect, using painter.

Parameters:
grid the controlling grid
row the row in visual coordinates
col the column in visual coordinates
itm the value to display. This value may be 0.
rect the rectangle to paint into
painter a painting context

Implemented in QicsCheckCellDisplay, QicsComboCellDisplay, QicsTextCellDisplay, and QicsWidgetCellDisplay.

virtual void QicsCellDisplay::drawBackground QicsGridInfo info,
int  row,
int  col,
const QRect &  rect,
const QPalette &  pal,
QPainter *  painter,
bool  is_current = false,
bool  is_selected = false
[protected, virtual, inherited]
 

Draws the background of cell (row, col ) using painter (based on cell and grid properties contained info) at the location specified by rect.

Parameters:
info grid info object
row the row in visual coordinates
col the column in visual coordinates
rect location to draw in
pal color group to draw with
painter painter to draw with
is_current is this cell the current cell?
is_selected is this cell selected?

virtual void QicsCellDisplay::drawBorder QicsGridInfo info,
int  row,
int  col,
const QRect &  rect,
const QPalette &  pal,
QPainter *  painter,
bool  is_current = false,
bool  is_selected = false
[protected, virtual, inherited]
 

Draws the border of cell (row, col ) (based on cell and grid properties contained in info at the location specified by rect.

Parameters:
info grid info object
row the row in visual coordinates
col the column in visual coordinates
rect location to draw in
pal color group to draw with
painter painter to draw with
is_current is this cell the current cell?
is_selected is this cell selected?

virtual bool QicsNoWidgetCellDisplay::editWhenCurrent void   )  const [inline, virtual]
 

Returns true if cells using this displayer should automatically be put into edit mode when they become the current cell in the table.

Implements QicsCellDisplay.

virtual void QicsNoWidgetCellDisplay::endEdit QicsScreenGrid grid,
int  row,
int  col
[virtual]
 

This method is a no-op in this abstract class.

Implements QicsCellDisplay.

virtual bool QicsCellDisplay::handleKeyEvent QicsScreenGrid grid,
int  row,
int  col,
QKeyEvent *  ke
[virtual, inherited]
 

Handler for keyboard events that occur within cell (row, col ). The handler must return true if the event was handled by the cell displayer (and thus should not be handled by the grid), or false otherwise.

Parameters:
grid the controlling grid
row the row in visual coordinates
col the column in visual coordinates
ke the keyboard event

Reimplemented in QicsCheckCellDisplay, QicsComboCellDisplay, and QicsTextCellDisplay.

virtual bool QicsCellDisplay::handleMouseEvent QicsScreenGrid grid,
int  row,
int  col,
QMouseEvent *  me
[virtual, inherited]
 

Handler for mouse events that occur within cell (row, col ). The handler must return true if the event was handled by the cell displayer (and thus should not be handled by the grid), or false otherwise.

Parameters:
grid the controlling grid
row the row in visual coordinates
col the column in visual coordinates
me the mouse event

Reimplemented in QicsCheckCellDisplay, and QicsComboCellDisplay.

virtual void QicsNoWidgetCellDisplay::hideEdit QicsScreenGrid  )  [virtual]
 

This method is a no-op in this abstract class.

Implements QicsCellDisplay.

virtual bool QicsCellDisplay::isCellSelected QicsGridInfo info,
int  row,
int  col
[protected, virtual, inherited]
 

Returns true if cell (row, col ) is selected in grids described by info. If the grid(s) are main table grids, this method simply determines if the cell is contained in the current selection list. If the grid(s) are header grids, this method determines if all the cells in the header cell's row or column are selected.

Parameters:
info grid info object
row the row in visual coordinates
col the column in visual coordinates

virtual bool QicsCellDisplay::isEmpty QicsGridInfo info,
int  row,
int  col,
const QicsDataItem itm
const [pure virtual, inherited]
 

Returns true if the contents of cell (row, col ) (given data item itm ) are empty, false otherwise.

Parameters:
info grid info object
row the row in visual coordinates
col the column in visual coordinates
itm item that will be displayed in the cell

Implemented in QicsCheckCellDisplay, QicsComboCellDisplay, QicsTextCellDisplay, and QicsWidgetCellDisplay.

virtual void QicsNoWidgetCellDisplay::moveEdit QicsScreenGrid ,
int  row,
int  col,
const QRect &  rect
[virtual]
 

This method is a no-op in this abstract class.

Implements QicsCellDisplay.

virtual bool QicsCellDisplay::needsVisibilityNotification void   )  const [inline, virtual, inherited]
 

Returns true if this displayer should be notified when its cells are no longer visible in the grid, false otherwise.

Reimplemented in QicsWidgetCellDisplay.

virtual QSize QicsCellDisplay::sizeHint QicsGrid grid,
int  row,
int  col,
const QicsDataItem itm
[pure virtual, inherited]
 

Returns the size that cell (row, col ) needs to be if it is to completely display itm.

Parameters:
grid the controlling grid
row the row in visual coordinates
col the column in visual coordinates
itm the value to display. This value may be 0.

Implemented in QicsCheckCellDisplay, QicsComboCellDisplay, QicsTextCellDisplay, and QicsWidgetCellDisplay.

virtual void QicsNoWidgetCellDisplay::startEdit QicsScreenGrid ,
int  row,
int  col,
const QicsDataItem
[virtual]
 

This method is a no-op in this abstract class.

Implements QicsCellDisplay.

virtual QString QicsCellDisplay::tooltipText QicsGridInfo info,
int  row,
int  col,
const QicsDataItem itm,
const QRect &  rect
const [virtual, inherited]
 

Returns the text that a grid widget can display in a tooltip when the user hovers the mouse pointer over this cell.

Parameters:
info grid info object
row the row in visual coordinates
col the column in visual coordinates
itm item that will be displayed in the cell
rect size of the cell

Reimplemented in QicsTextCellDisplay.


The documentation for this class was generated from the following file:

All trademarks and copyrights on this page are properties of their respective owners.
The rest is copyright 1999-2006 Integrated Computer Solutions, Inc.