A control that displays a set of tabular data. More...
import "UnoControlGrid.idl";
 
  
| Included Services | |
| service | com::sun::star::awt::UnoControl | 
| Exported Interfaces | |
| interface | ::com::sun::star::awt::grid::XGridControl | 
| interface | ::com::sun::star::awt::grid::XGridRowSelection | 
|  Exported Interfaces inherited from UnoControl | |
| interface | com::sun::star::lang::XComponent | 
| interface | com::sun::star::awt::XControl | 
| interface | com::sun::star::awt::XWindow | 
| interface | com::sun::star::awt::XView | 
| interface | com::sun::star::accessibility::XAccessible | 
| provides access to the accessible context associated with this object. | |
| Additional Inherited Members | |
|  Public Member Functions inherited from XComponent | |
| void | dispose () | 
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. | |
| void | addEventListener ([in] XEventListener xListener) | 
| adds an event listener to the object. | |
| void | removeEventListener ([in] XEventListener aListener) | 
| removes an event listener from the listener list. | |
|  Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
|  Public Member Functions inherited from XControl | |
| void | setContext ([in] com::sun::star::uno::XInterface Context) | 
| sets the context of the control. | |
| com::sun::star::uno::XInterface | getContext () | 
| gets the context of the control. | |
| void | createPeer ([in] com::sun::star::awt::XToolkit Toolkit, [in] com::sun::star::awt::XWindowPeer Parent) | 
| creates a "child" window on the screen. | |
| com::sun::star::awt::XWindowPeer | getPeer () | 
| returns the peer which was previously created or set. | |
| boolean | setModel ([in] com::sun::star::awt::XControlModel Model) | 
| sets a model for the control. | |
| com::sun::star::awt::XControlModel | getModel () | 
| returns the model for this control. | |
| com::sun::star::awt::XView | getView () | 
| returns the view of this control. | |
| void | setDesignMode ([in] boolean bOn) | 
| sets the design mode for use in a design editor. | |
| boolean | isDesignMode () | 
| returns TRUEif the control is in design mode,FALSEotherwise. | |
| boolean | isTransparent () | 
| returns TRUEif the control is transparent,FALSEotherwise. | |
|  Public Member Functions inherited from XWindow | |
| void | setPosSize ([in] long X, [in] long Y, [in] long Width, [in] long Height, [in] short Flags) | 
| sets the outer bounds of the window. | |
| com::sun::star::awt::Rectangle | getPosSize () | 
| returns the outer bounds of the window. | |
| void | setVisible ([in] boolean Visible) | 
| shows or hides the window depending on the parameter. | |
| void | setEnable ([in] boolean Enable) | 
| enables or disables the window depending on the parameter. | |
| void | setFocus () | 
| sets the focus to the window. | |
| void | addWindowListener ([in] com::sun::star::awt::XWindowListener xListener) | 
| adds a window listener to the object. | |
| void | removeWindowListener ([in] com::sun::star::awt::XWindowListener xListener) | 
| removes the specified window listener from the listener list. | |
| void | addFocusListener ([in] com::sun::star::awt::XFocusListener xListener) | 
| adds a focus listener to the object. | |
| void | removeFocusListener ([in] com::sun::star::awt::XFocusListener xListener) | 
| removes the specified focus listener from the listener list. | |
| void | addKeyListener ([in] com::sun::star::awt::XKeyListener xListener) | 
| adds a key listener to the object. | |
| void | removeKeyListener ([in] com::sun::star::awt::XKeyListener xListener) | 
| removes the specified key listener from the listener list. | |
| void | addMouseListener ([in] com::sun::star::awt::XMouseListener xListener) | 
| adds a mouse listener to the object. | |
| void | removeMouseListener ([in] com::sun::star::awt::XMouseListener xListener) | 
| removes the specified mouse listener from the listener list. | |
| void | addMouseMotionListener ([in] com::sun::star::awt::XMouseMotionListener xListener) | 
| adds a mouse motion listener to the object. | |
| void | removeMouseMotionListener ([in] com::sun::star::awt::XMouseMotionListener xListener) | 
| removes the specified mouse motion listener from the listener list. | |
| void | addPaintListener ([in] com::sun::star::awt::XPaintListener xListener) | 
| adds a paint listener to the object. | |
| void | removePaintListener ([in] com::sun::star::awt::XPaintListener xListener) | 
| removes the specified paint listener from the listener list. | |
|  Public Member Functions inherited from XView | |
| boolean | setGraphics ([in] com::sun::star::awt::XGraphics aDevice) | 
| sets the output device. | |
| com::sun::star::awt::XGraphics | getGraphics () | 
| returns the output device which was set using the method XView::setGraphics(). | |
| com::sun::star::awt::Size | getSize () | 
| returns the size of the object in device units. | |
| void | draw ([in] long nX, [in] long nY) | 
| draws the object at the specified position. | |
| void | setZoom ([in] float fZoomX, [in] float fZoomY) | 
| sets the zoom factor. | |
|  Public Member Functions inherited from XGridControl | |
| long | getColumnAtPoint ([in] long X, [in] long Y) | 
| retrieves the column which a given point belongs to | |
| long | getRowAtPoint ([in] long X, [in] long Y) | 
| retrieves the row which a given point belongs to | |
| long | getCurrentColumn () | 
| returns the column index of the currently active cell | |
| long | getCurrentRow () | 
| returns the row index of the currently active cell | |
| 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 | |
|  Public Member Functions inherited from XGridRowSelection | |
| void | selectAllRows () | 
| Selects all rows. | |
| void | selectRow ([in] long RowIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) | 
| selects a given row | |
| void | deselectAllRows () | 
| Deselects all selected rows. | |
| void | deselectRow ([in] long RowIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) | 
| removes the selection for a given row | |
| sequence< long > | getSelectedRows () | 
| Returns the indices of all selected rows. | |
| boolean | hasSelectedRows () | 
| Returns whether rows are selected. | |
| boolean | isRowSelected ([in] long RowIndex) | 
| Returns whether a specific row is selected. | |
| void | addSelectionListener ([in] XGridSelectionListener listener) | 
| Adds a listener for the GridSelectionEvent posted after the grid changes. | |
| void | removeSelectionListener ([in] XGridSelectionListener listener) | 
| Removes a listener previously added with addSelectionListener(). | |
|  Protected Member Functions inherited from XAccessible | |
| XAccessibleContext | getAccessibleContext () | 
| Returns the AccessibleContext associated with this object. | |
A control that displays a set of tabular data.
The horizontal structure of the grid is defined by the XGridColumnModel implemented in DefaultGridColumnModel The XGridColumn implemented in GridColumn describes the properties and behavior of a single column. Use the XGridColumnModel::addColumn() to add a column to the column model.
All row data are stored in the XGridDataModel. Use the DefaultGridDataModel to add XGridDataModel::addRow() or remove XGridDataModel::removeRow() rows.
The column and data model must be set at the UnoControlGridModel::ColumnModel and UnoControlGridModel::GridDataModel properties.
If you are interested in knowing when the selection changes implement a XGridSelectionListener and add the instance with the method XGridRowSelection::addSelectionListener(). You than will be notified for any selection change.
| service com::sun::star::awt::UnoControl |