diff options
Diffstat (limited to 'offapi/com/sun/star/text/DocumentIndexLevelFormat.idl')
| -rw-r--r-- | offapi/com/sun/star/text/DocumentIndexLevelFormat.idl | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl b/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl new file mode 100644 index 000000000000..3d54896f2d78 --- /dev/null +++ b/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl @@ -0,0 +1,188 @@ +/************************************************************************* + * + * $RCSfile: DocumentIndexLevelFormat.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:20 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_text_DocumentIndex_idl__ +#define __com_sun_star_text_DocumentIndex_idl__ + +#ifndef _com_sun_star_container_XIndexReplace_idl__ +#include <com/sun/star/container/XIndexReplace.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module text { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::text::DocumentIndexLevelFormat +/** This service provides access to the structure of the levels of document indexes. + + + <p> + The element type is Sequence&lt;PropertyValues &gt;. Each element in this sequence represents + a member of an index line. The following properties are part of such an element. + </p> + <ul> + <li> + <p>TokenType</p> + <p>Values:</p> + <ul> + <li> + <p>TokenEntryNumber - chapter number, used in content indexes + only</p> + </li> + <li> + <p>TokenEntryText - text of the entry + </p> + </li> + <li> + <p>TokenTabStop - tab stop + </p> + </li> + <li> + <p>TokenText - user defined text + </p> + </li> + <li> + <p>TokenPageNumber - page number + </p> + </li> + <li> + <p>TokenChapterInfo - chapter info, in alphabetical indexes + only</p> + </li> + <li> + <p>TokenHyperlinkStart - start of a hyperlink</p> + </li> + <li> + <p>TokenHyperlinkEnd - end of a hyperlink</p> + </li> + <li> + <p>TokenBibliographyDataField - bibliographic data field + </p> + </li> + </ul> + </li> + <li> + <p>CharacterStyleName</p> + <p>Name of the character style applied to the element. Invalid in tab stops.</p> + </li> + <li> + <p>TabStopRightAligned</p> + <p>Tab stop is right aligned. Only valid for tab stops.</p> + </li> + <li> + <p>TabStopPosition</p> + <p>Position of the tab stop. Only valid for tab stops.</p> + </li> + <li> + <p>TabStopFillCharacter</p> + <p>Fill character in tab stops.</p> + </li> + <li> + <p>Text</p> + <p>Text. Only valid in user defined text.</p> + </li> + <li> + <p>ChapterFormat</p> + <p>Valid in chapter info only. see <type>ChapterFormat</type> + </p> + </li> + </ul> + */ +service DocumentIndexLevelFormat +{ + // DocMerge: empty anyway + interface com::sun::star::container::XIndexReplace; + + //------------------------------------------------------------------------- + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:35:58 hjs + initial import + + Revision 1.4 2000/09/11 11:52:59 mi + documentation merged from XML + + Revision 1.2 2000/03/14 12:34:49 mi + bad documentation syntax + + Revision 1.1 2000/02/14 12:05:04 os + #72990# service DocumentIndexLevelFormat + + +=============================================================================*/ +#endif + + + + + + + |