QicsScrollBarScroller Class Reference

Table scroller using a QScrollBar widget as the UI. More...

#include <QicsScrollBarScroller.h>

List of all members.

Public Types

enum QicsWideKeyAction {
  Del_DeleteSelected, CtrlA_SelectAll, CtrlC_Copy, CtrlV_Paste,
  CtrlX_Cut
}

enum QicsBoxBorders {
  TopBorder = 1, BottomBorder = 2, LeftBorder = 4, RightBorder = 8,
  AllBorders = 1+2+4+8
}

enum QicsCopyPolicy {
  CopyData = 1, CopyAttributes = 2, CopyDimensions = 4, CopySpans = 8,
  CopyAll = 1+2+4+8
}

enum QicsClearPolicy { ClearData = 1, ClearAttributes = 2, ClearSpans = 4, ClearAll = 1+2+4 }

enum QicsSortMode { QicsStableSort = 0, QicsQuickSort }

enum QicsCellOverflowBehavior { Clip = 0, Overflow, ToolTip }

enum QicsCurrentCellStyle { Spreadsheet = 0, NormalSelected }

enum QicsSelectionStyle { Normal = 0, Exclusive }

enum QicsSelectCurrentCellPolicy { Follow = 0, Static }

enum QicsFillHandleEventType { FillHandlePressed = 0, FillHandleReleased, FillHandleDoubleClicked, FillHandleDragged }

enum QicsGridCellClipping { AllowPartial = 0, NoDisplayOnPartial, UseClippedSymbol }

enum QicsGridType { TableGrid = 0, RowHeaderGrid, ColumnHeaderGrid }

enum QicsHeaderType { RowHeader = 0, ColumnHeader }

enum QicsIndexType { NoIndex = 0, RowIndex, ColumnIndex, RowAndColumnIndex }

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 = 1, ScrollDown = 2, ScrollLeft = 4,
  ScrollRight = 8, ScrollToRow = 16, ScrollToColumn = 32
}

enum QicsSelectionPolicy {
  SelectNone = 0, SelectSingle, SelectMultiple, SelectSingleRow,
  SelectMultipleRow
}

enum QicsSelectionType {
  SelectionNone = 0, SelectionBegin, SelectionDrag, SelectionEnd,
  SelectionExtend, SelectionAdd, SelectionReplace
}

enum QicsSortOrder { Ascending = 0, Descending }

enum QicsTableDisplayOption { DisplayNever = 0, DisplayAlways, DisplayFirstPage }

enum QicsTraversalKeyEditBehavior { TraverseWithinCell = 0, TraverseBetweenCells }

enum QicsCurrentCellDraggingPolicy { DragCurrent = 0, DragSelection }

enum QicsCellWidthMode { NoChange = 0, ChangeOnlyHeight, ChangeHeightWidth }

enum QicsCellDecorationStyle { Flat = 0, Styled = 1 }

enum QicsHeaderDragStyle { SimpleDrag = 0, StyledDrag = 1 }

enum QicsAutoFitMode { Native = 0, Excel }

Public Slots

virtual int index (void) const

virtual void setIndex (Qics::QicsIndexType type, int idx)

virtual int minIndex (void) const

virtual void setMinIndex (Qics::QicsIndexType type, int idx)

virtual int maxIndex (void) const

virtual void setMaxIndex (Qics::QicsIndexType type, int idx)

void handleSliderPressed (void)

void handleSliderReleased (void)

void handleActionTriggered (int action)

Signals

void indexChanged (Qics::QicsIndexType type, int idx)

void scrollPageAdd (Qics::QicsIndexType type, int idx)

void scrollPageSub (Qics::QicsIndexType type, int idx)

Public Member Functions

QicsScrollBarScroller (Qics::QicsIndexType type, QWidget *parent)

virtual ~QicsScrollBarScroller ()

virtual QAbstractSlider * widget (void) const

virtual void setWidget (QAbstractSlider *widget)

virtual QicsScrollBarMode mode (void) const

virtual void setMode (QicsScrollBarMode m)

bool scrollSliderDrag (void) const

virtual void setMode (QicsScrollBarMode m)=0

Sets mode of scroller.

Static Public Attributes

static const int QicsLAST_ROW = INT_MAX-1

static const int QicsLAST_COLUMN = INT_MAX-1

Protected Slots

void valueChanged (int val)

Protected Member Functions

void checkBounds (void)

Protected Attributes

QAbstractSlider * myScrollBar

the scrollbar widget

Qics::QicsIndexType myType

the type of this scroller

bool myInSetIndex

flag used in setIndex to avoid recursive signals

bool myIsSliderPressed

flag which store slider press action

int oldVal

QicsScrollBarMode myMode

controls the mode of the scrollbar

Detailed Description

Table scroller using a QScrollBar widget as the UI.

QicsScrollBarScroller is an implementation of QicsScroller that uses a generic QScrollBar widget as its UI.

Member Enumeration Documentation

enum Qics::QicsWideKeyAction [inherited]

Denotes global key actions available for the table grid.

Del_DeleteSelected Pressing Delete removes data from the selected cells.
CtrlA_SelectAll Pressing Control+A selects all the cells in the grid.

enum Qics::QicsBoxBorders [inherited]

Denotes the box borders of cell region.

TopBorder Top border of the region.
BottomBorder Bottom border of the region.
LeftBorder Left border of the region.
RightBorder Right border of the region.

enum Qics::QicsCopyPolicy [inherited]

Denotes the copying policy during copy/paste and drag/drop operations.

CopyData Copy data from cells.
CopyAttributes Copy cell attributes.
CopyDimensions Copy cell dimensions (width/height).
CopySpans Copy spanned cells.

enum Qics::QicsClearPolicy [inherited]

Denotes the clearing policy during cut and delete operations.

ClearData Clear data from cells.
ClearAttributes Clear cell attributes.
ClearSpans Clear spanned cells.

enum Qics::QicsSortMode [inherited]

Denotes the sort algorithm which is used.

QicsStableSort Used non-destructive, stable sort algorithm.
QicsQuickSort Default quick sort algorithm.

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::QicsSelectionStyle [inherited]

Normal The selection will be drawn by the normal way.
Exclusive The selection will be drawn with border like in MS Excel.

enum Qics::QicsSelectCurrentCellPolicy [inherited]

Follow The current cell will follow the selection (QicsTable style).
Static The current cell will stay on selection anchor (MS Excel style).
Since:
2.3

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.
SelectMultiple 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::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.

enum Qics::QicsCurrentCellDraggingPolicy [inherited]

Specifies the behavior of drag&drop operations when it has began from current cell.

DragCurrent - only current cell is dragging.
DragSelection - whole selection is dragging.

enum Qics::QicsCellWidthMode [inherited]

Specifies the behavior of set cell font.

NoChange - does not change size of cells.
ChangeOnlyHeight - changing only height of the cell when new font is applies (cell width is not changed).
ChangeHeightWidth - changing height and width.

enum Qics::QicsCellDecorationStyle [inherited]

Specifies the cell decoration style for headers.

Flat Header cells are drawn flat, just like as ordinal cells.
Styled Header cells are drawn with different look.

enum Qics::QicsHeaderDragStyle [inherited]

Specifies row/column drag style for headers.

SimpleDrag Only drag cursor is used to indicate drag process.
StyledDrag Extended image is used to indicate drag process.

enum Qics::QicsAutoFitMode [inherited]

Specifies autofit modes.

Native It toggles between the user defined and minimal width (default).
Excel It is just setting the minimal width.

Constructor & Destructor Documentation

QicsScrollBarScroller::QicsScrollBarScroller	(	Qics::QicsIndexType	type,
		QWidget *	parent
	)

The constructor. type specifies if this scroller should control rows or columns. parent specifies the parent of the scrollbar widget. name specifies the name of this object.

virtual QicsScrollBarScroller::~QicsScrollBarScroller ( ) [virtual]

The destructor.

Member Function Documentation

virtual QAbstractSlider* QicsScrollBarScroller::widget ( void ) const [inline, virtual]

Returns the QScrollBar widget of this scroller.

Implements QicsScroller.

virtual void QicsScrollBarScroller::setWidget ( QAbstractSlider * widget ) [virtual]

Sets new widget for this scroller. Old widget deletes automatically.

Implements QicsScroller.

virtual QicsScrollBarMode QicsScrollBarScroller::mode ( void ) const [inline, virtual]

Returns the mode of the scrollbar.

Implements QicsScroller.

virtual void QicsScrollBarScroller::setMode ( QicsScrollBarMode m ) [virtual]

Sets the mode of the scrollbar.

bool QicsScrollBarScroller::scrollSliderDrag ( void ) const [inline]

Returns true if slider in drag mode.

virtual int QicsScrollBarScroller::index ( void ) const [inline, virtual, slot]

Returns the current index of the scroller.

Implements QicsScroller.

virtual void QicsScrollBarScroller::setIndex	(	Qics::QicsIndexType	type,
		int	idx
	)			`[virtual, slot]`

Sets the current type index of the scroller to idx. The request is ignored if type is not the same as the type that was passed to the constructor.

Implements QicsScroller.

virtual int QicsScrollBarScroller::minIndex ( void ) const [inline, virtual, slot]

Returns the current minimum index of the scroller.

Implements QicsScroller.

virtual void QicsScrollBarScroller::setMinIndex	(	Qics::QicsIndexType	type,
		int	idx
	)			`[virtual, slot]`

Sets the current type minimum index of the scroller to idx. The request is ignored if type is not the same as the type that was passed to the constructor.

Implements QicsScroller.

virtual int QicsScrollBarScroller::maxIndex ( void ) const [inline, virtual, slot]

Returns the current maximum index of the scroller.

Implements QicsScroller.

virtual void QicsScrollBarScroller::setMaxIndex	(	Qics::QicsIndexType	type,
		int	idx
	)			`[virtual, slot]`

Sets the current type maximum index of the scroller to idx. The request is ignored if type is not the same as the type that was passed to the constructor.

Implements QicsScroller.

void QicsScrollBarScroller::handleSliderPressed ( void ) [slot]

This clot handle mouse pressing on slider.

void QicsScrollBarScroller::handleSliderReleased ( void ) [slot]

Handle mouse release on slider.

void QicsScrollBarScroller::valueChanged ( int val ) [protected, slot]

Called when the scrollbar widget's value changes.

void QicsScrollBarScroller::checkBounds ( void ) [protected]

Checks the min and max indices and hideWhenNotNeeded to determine if the scrollbar should be hidden or shown.

virtual void QicsScroller::setMode ( QicsScrollBarMode m ) [pure virtual, inherited]

Sets mode of scroller.

void QicsScroller::indexChanged	(	Qics::QicsIndexType	type,
		int	idx
	)			`[signal, inherited]`

Emitted when the index of this scroller changes. type specifies whether this index is for a row or a column. idx is the new index value.

Member Data Documentation

QAbstractSlider* QicsScrollBarScroller::myScrollBar [protected]

the scrollbar widget

Qics::QicsIndexType QicsScrollBarScroller::myType [protected]

the type of this scroller

bool QicsScrollBarScroller::myInSetIndex [protected]

flag used in setIndex to avoid recursive signals

bool QicsScrollBarScroller::myIsSliderPressed [protected]

flag which store slider press action

QicsScrollBarMode QicsScrollBarScroller::myMode [protected]

controls the mode of the scrollbar

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

QicsScrollBarScroller.h


Public Types
enum	QicsWideKeyAction { Del_DeleteSelected, CtrlA_SelectAll, CtrlC_Copy, CtrlV_Paste, CtrlX_Cut }
enum	QicsBoxBorders { TopBorder = 1, BottomBorder = 2, LeftBorder = 4, RightBorder = 8, AllBorders = 1+2+4+8 }
enum	QicsCopyPolicy { CopyData = 1, CopyAttributes = 2, CopyDimensions = 4, CopySpans = 8, CopyAll = 1+2+4+8 }
enum	QicsClearPolicy { ClearData = 1, ClearAttributes = 2, ClearSpans = 4, ClearAll = 1+2+4 }
enum	QicsSortMode { QicsStableSort = 0, QicsQuickSort }
enum	QicsCellOverflowBehavior { Clip = 0, Overflow, ToolTip }
enum	QicsCurrentCellStyle { Spreadsheet = 0, NormalSelected }
enum	QicsSelectionStyle { Normal = 0, Exclusive }
enum	QicsSelectCurrentCellPolicy { Follow = 0, Static }
enum	QicsFillHandleEventType { FillHandlePressed = 0, FillHandleReleased, FillHandleDoubleClicked, FillHandleDragged }
enum	QicsGridCellClipping { AllowPartial = 0, NoDisplayOnPartial, UseClippedSymbol }
enum	QicsGridType { TableGrid = 0, RowHeaderGrid, ColumnHeaderGrid }
enum	QicsHeaderType { RowHeader = 0, ColumnHeader }
enum	QicsIndexType { NoIndex = 0, RowIndex, ColumnIndex, RowAndColumnIndex }
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 = 1, ScrollDown = 2, ScrollLeft = 4, ScrollRight = 8, ScrollToRow = 16, ScrollToColumn = 32 }
enum	QicsSelectionPolicy { SelectNone = 0, SelectSingle, SelectMultiple, SelectSingleRow, SelectMultipleRow }
enum	QicsSelectionType { SelectionNone = 0, SelectionBegin, SelectionDrag, SelectionEnd, SelectionExtend, SelectionAdd, SelectionReplace }
enum	QicsSortOrder { Ascending = 0, Descending }
enum	QicsTableDisplayOption { DisplayNever = 0, DisplayAlways, DisplayFirstPage }
enum	QicsTraversalKeyEditBehavior { TraverseWithinCell = 0, TraverseBetweenCells }
enum	QicsCurrentCellDraggingPolicy { DragCurrent = 0, DragSelection }
enum	QicsCellWidthMode { NoChange = 0, ChangeOnlyHeight, ChangeHeightWidth }
enum	QicsCellDecorationStyle { Flat = 0, Styled = 1 }
enum	QicsHeaderDragStyle { SimpleDrag = 0, StyledDrag = 1 }
enum	QicsAutoFitMode { Native = 0, Excel }
Public Slots
virtual int	index (void) const
virtual void	setIndex (Qics::QicsIndexType type, int idx)
virtual int	minIndex (void) const
virtual void	setMinIndex (Qics::QicsIndexType type, int idx)
virtual int	maxIndex (void) const
virtual void	setMaxIndex (Qics::QicsIndexType type, int idx)
void	handleSliderPressed (void)
void	handleSliderReleased (void)
void	handleActionTriggered (int action)
Signals
void	indexChanged (Qics::QicsIndexType type, int idx)
void	scrollPageAdd (Qics::QicsIndexType type, int idx)
void	scrollPageSub (Qics::QicsIndexType type, int idx)
Public Member Functions
	QicsScrollBarScroller (Qics::QicsIndexType type, QWidget *parent)
virtual	~QicsScrollBarScroller ()
virtual QAbstractSlider *	widget (void) const
virtual void	setWidget (QAbstractSlider *widget)
virtual QicsScrollBarMode	mode (void) const
virtual void	setMode (QicsScrollBarMode m)
bool	scrollSliderDrag (void) const
virtual void	setMode (QicsScrollBarMode m)=0
	Sets mode of scroller.
Static Public Attributes
static const int	QicsLAST_ROW = INT_MAX-1
static const int	QicsLAST_COLUMN = INT_MAX-1
Protected Slots
void	valueChanged (int val)
Protected Member Functions
void	checkBounds (void)
Protected Attributes
QAbstractSlider *	myScrollBar
	the scrollbar widget
Qics::QicsIndexType	myType
	the type of this scroller
bool	myInSetIndex
	flag used in setIndex to avoid recursive signals
bool	myIsSliderPressed
	flag which store slider press action
int	oldVal
QicsScrollBarMode	myMode
	controls the mode of the scrollbar

QicsTable Documentation Set

QicsScrollBarScroller Class Reference

Public Types

Public Slots

Signals

Public Member Functions

Static Public Attributes

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation