summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/DocumentIndexMarkAsian.idl')
-rw-r--r--offapi/com/sun/star/text/DocumentIndexMarkAsian.idl70
1 files changed, 70 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl b/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl
new file mode 100644
index 000000000000..f2909be2dcca
--- /dev/null
+++ b/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl
@@ -0,0 +1,70 @@
+/*************************************************************************
+ *
+ * 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_DocumentIndexMarkAsian_idl__
+#define __com_sun_star_text_DocumentIndexMarkAsian_idl__
+
+
+
+//=============================================================================
+
+ module com { module sun { module star { module text {
+
+//=============================================================================
+
+/** is a <type>TextRange</type> which is explicitly marked
+ as an index entry for a <type>DocumentIndex</type>.
+ For Asian languages the user can provide an additional string
+ which is used for sorting. If the user does not provide these
+ strings, they are not considered for sorting.
+
+ @since OOo 1.1.2
+ */
+published service DocumentIndexMarkAsian
+{
+ //-------------------------------------------------------------------------
+ /** contains the reading of the string which has been chosen for the
+ index entry.
+ */
+ [property] string TextReading;
+ //-------------------------------------------------------------------------
+ /** contains the reading of the primary key of the index entry.
+ It is used to build a hierarchical document index.
+ */
+ [property] string PrimaryKeyReading;
+ //-------------------------------------------------------------------------
+ /** contains the reading the secondary key of the index entry.
+ It is used to build a hierarchical document index.
+ */
+ [property] string SecondaryKeyReading;
+};
+
+//=============================================================================
+
+}; }; }; };
+#endif
+
+