LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XGridControl Interface Referencepublished

An interface to a control that displays a tabular data. More...

import"XGridControl.idl";

Inheritance diagram for XGridControl:
UnoControlGrid

Public Member Functions

long getColumnAtPoint ([in] long X, [in] long Y)
 retrieves the column which a given point belongs to More...
 
long getRowAtPoint ([in] long X, [in] long Y)
 retrieves the row which a given point belongs to More...
 
long getCurrentColumn ()
 returns the column index of the currently active cell More...
 
long getCurrentRow ()
 returns the row index of the currently active cell More...
 
void goToCell ([in] long ColumnIndex, [in] long RowIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException , ::com::sun::star::util::VetoException )
 moves the cursor to the given cell More...
 

Detailed Description

An interface to a control that displays a tabular data.

See also
UnoControlGrid
Since
OOo 3.3

Member Function Documentation

long getColumnAtPoint ( [in] long  X,
[in] long  Y 
)

retrieves the column which a given point belongs to

Parameters
Xthe ordinate of the point, in pixel coordinates.
Ythe abscissa of the point, in pixel coordinates.
Returns
the index of the column which the point lies in, or -1 if no column is under the given point.
long getCurrentColumn ( )

returns the column index of the currently active cell

If the grid control's does not contain any cells (which happens if the grid column model does not contain any columns, or if grid data model does not contain any rows), then -1 is returned.

long getCurrentRow ( )

returns the row index of the currently active cell

If the grid control's does not contain any cells (which happens if the grid column model does not contain any columns, or if grid data model does not contain any rows), then -1 is returned.

long getRowAtPoint ( [in] long  X,
[in] long  Y 
)

retrieves the row which a given point belongs to

Parameters
Xthe ordinate of the point, in pixel coordinates.
Ythe abscissa of the point, in pixel coordinates.
Returns
the index of the row which the point lies in, or -1 if no row is under the given point.
void goToCell ( [in] long  ColumnIndex,
[in] long  RowIndex 
)
raises ( ::com::sun::star::lang::IndexOutOfBoundsException ,
::com::sun::star::util::VetoException
)

moves the cursor to the given cell

Parameters
ColumnIndexthe column index of the cell to activate.
RowIndexthe row index of the cell to activate.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif either ColumnIndex or RowIndex are out of range.
com::sun::star::util::VetoExceptionif moving the cursor to another cell is vetoed.

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