defines a callback interface to be implemented by a concrete table control More...

#include <tablecontrolinterface.hxx>

Inheritance diagram for svt::table::ITableControl:

Public Member Functions
virtual void	hideCursor ()=0
	hides the cell cursor More...

virtual void	showCursor ()=0
	shows the cell cursor More...

virtual bool	dispatchAction (TableControlAction _eAction)=0
	dispatches an action to the table control More...

virtual SelectionEngine *	getSelEngine ()=0
	returns selection engine More...

virtual PTableModel	getModel () const =0
	returns the table model More...

virtual ColPos	getCurrentColumn () const =0
	returns the index of the currently active column More...

virtual RowPos	getCurrentRow () const =0
	returns the index of the currently active row More...

virtual void	activateCell (ColPos const i_col, RowPos const i_row)=0
	activates the given cell More...

virtual ::Size	getTableSizePixel () const =0
	retrieves the size of the table window, in pixels More...

virtual void	setPointer (PointerStyle i_pointer)=0
	sets a new mouse pointer for the table window More...

virtual void	captureMouse ()=0
	captures the mouse to the table window More...

virtual void	releaseMouse ()=0
	releases the mouse, after it had previously been captured More...

virtual void	invalidate (TableArea const i_what)=0
	invalidates the table window More...

virtual tools::Long	pixelWidthToAppFont (tools::Long const i_pixels) const =0
	calculates a width, given in pixels, into an AppFont-based width More...

virtual void	showTracking (tools::Rectangle const &i_location, ShowTrackFlags const i_flags)=0
	shows a tracking rectangle More...

virtual void	hideTracking ()=0
	hides a previously shown tracking rectangle More...

virtual TableCell	hitTest (const Point &rPoint) const =0
	does a hit test for the given pixel coordinates More...

virtual ColumnMetrics	getColumnMetrics (ColPos const i_column) const =0
	retrieves the metrics for a given column More...

virtual bool	isRowSelected (RowPos _nRow) const =0
	determines whether a given row is selected More...

virtual	~ITableControl ()

Detailed Description

defines a callback interface to be implemented by a concrete table control

Definition at line 150 of file tablecontrolinterface.hxx.

Constructor & Destructor Documentation

◆ ~ITableControl()

virtual svt::table::ITableControl::~ITableControl ( )

inlinevirtual

Definition at line 232 of file tablecontrolinterface.hxx.

Member Function Documentation

◆ activateCell()

virtual void svt::table::ITableControl::activateCell	(	ColPos const	i_col,
		RowPos const	i_row
	)

pure virtual

activates the given cell

Implemented in svt::table::TableControl_Impl.

Referenced by svt::table::RowSelection::handleMouseDown().

◆ captureMouse()

virtual void svt::table::ITableControl::captureMouse ( )

pure virtual

captures the mouse to the table window

Implemented in svt::table::TableControl_Impl.

Referenced by svt::table::ColumnResize::handleMouseDown().

◆ dispatchAction()

virtual bool svt::table::ITableControl::dispatchAction ( TableControlAction _eAction )

pure virtual

dispatches an action to the table control

Returns: <TRUE> if the action could be dispatched successfully, <FALSE> otherwise. Usual failure conditions include some other instance vetoing the action, or impossibility to execute the action at all (for instance moving up one row when already positioned on the very first row).

See also: TableControlAction

Implemented in svt::table::TableControl_Impl.

Referenced by svt::table::DefaultInputHandler::KeyInput().

◆ getColumnMetrics()

virtual ColumnMetrics svt::table::ITableControl::getColumnMetrics ( ColPos const i_column ) const

pure virtual

retrieves the metrics for a given column

Implemented in svt::table::TableControl_Impl.

Referenced by svt::table::ColumnResize::handleMouseMove(), and svt::table::ColumnResize::handleMouseUp().

◆ getCurrentColumn()

virtual ColPos svt::table::ITableControl::getCurrentColumn ( ) const

pure virtual

returns the index of the currently active column

Implemented in svt::table::TableControl_Impl.

◆ getCurrentRow()

virtual RowPos svt::table::ITableControl::getCurrentRow ( ) const

pure virtual

returns the index of the currently active row

Implemented in svt::table::TableControl_Impl.

◆ getModel()

virtual PTableModel svt::table::ITableControl::getModel ( ) const

pure virtual

returns the table model

The returned model is guaranteed to not be <NULL>.

Implemented in svt::table::TableControl_Impl.

Referenced by svt::table::ColumnSortHandler::handleMouseDown(), svt::table::ColumnResize::handleMouseUp(), and svt::table::ColumnSortHandler::handleMouseUp().

◆ getSelEngine()

virtual SelectionEngine * svt::table::ITableControl::getSelEngine ( )

pure virtual

returns selection engine

Implemented in svt::table::TableControl_Impl.

Referenced by svt::table::RowSelection::handleMouseDown(), and svt::table::RowSelection::handleMouseUp().

◆ getTableSizePixel()

virtual ::Size svt::table::ITableControl::getTableSizePixel ( ) const

pure virtual

retrieves the size of the table window, in pixels

Implemented in svt::table::TableControl_Impl.

Referenced by svt::table::ColumnResize::handleMouseMove().

◆ hideCursor()

virtual void svt::table::ITableControl::hideCursor ( )

pure virtual

hides the cell cursor

The method cares for successive calls, that is, for every call to ->hideCursor(), you need one call to ->showCursor. Only if the number of both calls matches, the cursor is really shown.