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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XListBox.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_grid_XGridSelection_idl__
  31 #define __com_sun_star_awt_grid_XGridSelection_idl__
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34 #include <com/sun/star/awt/grid/XGridSelectionListener.idl>
  35 #include <com/sun/star/view/SelectionType.idl>
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module awt { module grid {
  40
  41 //=============================================================================
  42
  43 /** This interfaces provides access to the selection of row for <type>UnoControlGrid</type>.
  44  */
  45 interface XGridSelection: com::sun::star::uno::XInterface
  46 {
  47     /** Returns the lowest index of the selection.
  48         @returns
  49             the lowest index.
  50     */
  51     long getMinSelectionIndex();
  52
  53     /** Returns the highest index of the selection.
  54         @returns
  55             the highest index.
  56     */
  57     long getMaxSelectionIndex();
  58
  59     /** Adds a selection intervall.
  60         @param start
  61                 the start row index.
  62         @param length
  63                 the number of rows to be selected.
  64     */
  65     [oneway] void insertIndexIntervall( [in] long start, [in] long length);
  66
  67     /** Removes a selection intervall.
  68         @param start
  69                 the start row index.
  70         @param length
  71                 the number of rows to be selected.
  72     */
  73     [oneway] void removeIndexIntervall( [in] long start, [in] long length);
  74
  75     /** Returns the indicies of all selected rows.
  76         @returns
  77             a sequence of indicies.
  78     */
  79     sequence< long > getSelection();
  80
  81     /** Returns whether rows are selected.
  82         @returns
  83             <true/> if rows are selected otherwise <false/>.
  84     */
  85     boolean isSelectionEmpty();
  86
  87     /** Returns whether a specific row is selected.
  88         @param
  89             the index of a row.
  90         @returns
  91             <true/> if row are selected otherwise <false/>.
  92     */
  93     boolean isSelectedIndex( [in] long index);
  94
  95     /** Marks a row as selected.
  96         @param
  97             the index of a row.
  98     */
  99     [oneway] void selectRow( [in] long y);
 100
 101     /*
 102     [oneway] void selectColumn( [in] long x);
 103     */
 104
 105     /** Adds a listener for the <type>GridSelectionEvent</type> posted after the grid changes.
 106         @param Listener
 107             the listener to add.
 108     */
 109     [oneway] void addSelectionListener( [in] XGridSelectionListener  listener);
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** Removes a listener previously added with <method>addSelectionListener()</method>.
 114         @param Listener
 115             the listener to remove.
 116     */
 117     [oneway] void removeSelectionListener( [in] XGridSelectionListener listener);
 118
 119
 120 };
 121
 122 //=============================================================================
 123
 124 }; }; }; }; };
 125
 126 #endif