offapi/com/sun/star/sheet/DataPilotItem.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: DataPilotItem.idl,v $
  10  * $Revision: 1.6 $
  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
  31 #ifndef __com_sun_star_sheet_DataPilotItem_idl__
  32 #define __com_sun_star_sheet_DataPilotItem_idl__
  33
  34 #ifndef __com_sun_star_container_XNamed_idl__
  35 #include <com/sun/star/container/XNamed.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_XPropertySet_idl__
  39 #include <com/sun/star/beans/XPropertySet.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** represents a single item in a data pilot field.
  49  */
  50 service DataPilotItem
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** provides access to the name of the data pilot item.
  55
  56         <p>Only the <code>getName()</code> method is provided.</p>
  57      */
  58     interface com::sun::star::container::XNamed;
  59
  60     //-------------------------------------------------------------------------
  61
  62 //! service PropertySet
  63     /** provides access to the properties.
  64      */
  65     interface com::sun::star::beans::XPropertySet;
  66
  67     //=========================================================================
  68
  69     /** specifies whether the item is showing detail.
  70      */
  71     [property] boolean ShowDetail;
  72
  73     //=========================================================================
  74
  75     /** specifies whether the item is hidden.
  76     */
  77     [property] boolean IsHidden;
  78
  79     //=========================================================================
  80
  81     /** specifies the item's position in its field if sorting is manual.
  82
  83         @since OOo 2.4.0
  84      */
  85     [optional, property] long Position;
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif
  93