offapi/com/sun/star/awt/grid/XGridSelection.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_grid_XGridSelection_idl__
  29 #define __com_sun_star_awt_grid_XGridSelection_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/awt/grid/XGridSelectionListener.idl>
  33 #include <com/sun/star/view/SelectionType.idl>
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module awt { module grid {
  38
  39 //=============================================================================
  40
  41 /** This interfaces provides access to the selection of row for <type>UnoControlGrid</type>.
  42  */
  43 interface XGridSelection
  44 {
  45     /** Selects all rows.
  46     */
  47     void selectAllRows();
  48
  49     /** selects a given row
  50
  51         @param RowIndex
  52             denotes the index of the row to select
  53     */
  54     void selectRow( [in] long RowIndex );
  55
  56     /** Deselects all selected rows.
  57     */
  58     void deselectAllRows();
  59
  60     /** removes the selection for a given row
  61
  62         @param RowIndex
  63             denotes the index of the row to deselect
  64     */
  65     void deselectRow( [in] long RowIndex );
  66
  67     /** Returns the indices of all selected rows.
  68         @returns
  69             a sequence of indices.
  70     */
  71     sequence< long > getSelection();
  72
  73     /** Returns whether rows are selected.
  74         @returns
  75             <true/> if rows are selected otherwise <false/>.
  76     */
  77     boolean isSelectionEmpty();
  78
  79     /** Returns whether a specific row is selected.
  80         @param
  81             the index of a row.
  82         @returns
  83             <true/> if row are selected otherwise <false/>.
  84     */
  85     boolean isSelectedIndex( [in] long index);
  86
  87     /** Adds a listener for the <type>GridSelectionEvent</type> posted after the grid changes.
  88         @param listener
  89             the listener to add.
  90     */
  91     void addSelectionListener( [in] XGridSelectionListener  listener);
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** Removes a listener previously added with <method>addSelectionListener()</method>.
  96         @param listener
  97             the listener to remove.
  98     */
  99     void removeSelectionListener( [in] XGridSelectionListener listener);
 100
 101
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; }; };
 107
 108 #endif
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */