office-gobmx/offapi/com/sun/star/text/TableIndex.idl

71 lines
2.6 KiB
Text

/*************************************************************************
*
* 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_text_TableIndex_idl__
#define __com_sun_star_text_TableIndex_idl__
#include <com/sun/star/text/BaseIndex.idl>
//=============================================================================
module com { module sun { module star { module text {
//=============================================================================
/** specifies service of table indexes within a document.
@see com::sun::star::text::BaseIndex
*/
published service TableIndex
{
service com::sun::star::text::BaseIndex;
//-------------------------------------------------------------------------
/** determines if the name or the label of an object is used to create the index.
*/
[optional, property] boolean CreateFromLabels; //tables, illustrations
//-------------------------------------------------------------------------
/** determines the name of the sequence field that is evaluated to create the index.
*/
[optional, property] string LabelCategory; //tables, illustrations
//-------------------------------------------------------------------------
/** determines the way the paragraph containing a label is included in the index.
@see ReferenceFieldPart allowed constant values: only TEXT, CATEGORY_AND_NUMBER and
ONLY_CAPTION
*/
[optional, property] short LabelDisplayType;//tables, illustrations
};
//=============================================================================
}; }; }; };
#endif