offapi/com/sun/star/sheet/DataPilotItem.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_DataPilotItem_idl__
  29 #define __com_sun_star_sheet_DataPilotItem_idl__
  30
  31 #ifndef __com_sun_star_container_XNamed_idl__
  32 #include <com/sun/star/container/XNamed.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_beans_XPropertySet_idl__
  36 #include <com/sun/star/beans/XPropertySet.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** represents a single item in a data pilot field.
  46  */
  47 service DataPilotItem
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** provides access to the name of the data pilot item.
  52
  53         <p>Only the <code>getName()</code> method is provided.</p>
  54      */
  55     interface com::sun::star::container::XNamed;
  56
  57     //-------------------------------------------------------------------------
  58
  59 //! service PropertySet
  60     /** provides access to the properties.
  61      */
  62     interface com::sun::star::beans::XPropertySet;
  63
  64     //=========================================================================
  65
  66     /** specifies whether the item is showing detail.
  67      */
  68     [property] boolean ShowDetail;
  69
  70     //=========================================================================
  71
  72     /** specifies whether the item is hidden.
  73     */
  74     [property] boolean IsHidden;
  75
  76     //=========================================================================
  77
  78     /** specifies the item's position in its field if sorting is manual.
  79
  80         @since OOo 2.4.0
  81      */
  82     [optional, property] long Position;
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif
  90