Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: awt :: grid ::
interface XGridControl
Description An interface to a control that displays a tabular data. Since OOo 3.3 See also UnoControlGrid

Methods' Summary
getColumnAtPoint | retrieves the column which a given point belongs to
getRowAtPoint | retrieves the row which a given point belongs to
getCurrentColumn | returns the column index of the currently active cell
getCurrentRow | returns the row index of the currently active cell
goToCell | moves the cursor to the given cell

Methods' Details
getColumnAtPoint
long
getColumnAtPoint( | [in] long | X,
| [in] long | Y );
Description retrieves the column which a given point belongs to Parameter X the ordinate of the point, in pixel coordinates. Parameter Y the 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.
getRowAtPoint
long
getRowAtPoint( | [in] long | X,
| [in] long | Y );
Description retrieves the row which a given point belongs to Parameter X the ordinate of the point, in pixel coordinates. Parameter Y the 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.
getCurrentColumn
long
getCurrentColumn();
Description 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.
getCurrentRow
long
getCurrentRow();
Description 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.
goToCell
void
goToCell( | [in] long | ColumnIndex,
| [in] long | RowIndex )
raises( | ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::util::VetoException );
Description moves the cursor to the given cell Parameter ColumnIndex the column index of the cell to activate. Parameter RowIndex the row index of the cell to activate. Throws ::com::sun::star::lang::IndexOutOfBoundsException if either `ColumnIndex` or `RowIndex` are out of range. Throws ::com::sun::star::util::VetoException if moving the cursor to another cell is vetoed.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.