xref: /trunk/main/offapi/com/sun/star/sheet/DataPilotItem.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_DataPilotItem_idl__
#define __com_sun_star_sheet_DataPilotItem_idl__

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** represents a single item in a data pilot field.
 */
service DataPilotItem
{
	//-------------------------------------------------------------------------

	/** provides access to the name of the data pilot item.

	    <p>Only the <code>getName()</code> method is provided.</p>
	 */
	interface com::sun::star::container::XNamed;

	//-------------------------------------------------------------------------

//! service PropertySet
	/** provides access to the properties.
	 */
	interface com::sun::star::beans::XPropertySet;

    //=========================================================================

	/** specifies whether the item is showing detail.
	 */
	[property] boolean ShowDetail;

    //=========================================================================

    /** specifies whether the item is hidden.
    */
    [property] boolean IsHidden;

    //=========================================================================

    /** specifies the item's position in its field if sorting is manual.

        @since OOo 2.4
     */
    [optional, property] long Position;
};

//=============================================================================

}; }; }; };

#endif