summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/BaseIndexMark.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/BaseIndexMark.idl')
-rw-r--r--offapi/com/sun/star/text/BaseIndexMark.idl61
1 files changed, 61 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/BaseIndexMark.idl b/offapi/com/sun/star/text/BaseIndexMark.idl
new file mode 100644
index 000000000000..97632664ae27
--- /dev/null
+++ b/offapi/com/sun/star/text/BaseIndexMark.idl
@@ -0,0 +1,61 @@
+/*************************************************************************
+ *
+ * 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_BaseIndexMark_idl__
+#define __com_sun_star_text_BaseIndexMark_idl__
+
+#ifndef __com_sun_star_text_TextContent_idl__
+#include <com/sun/star/text/TextContent.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module text {
+
+//=============================================================================
+
+/** is a <type>TextRange</type> which is explicitly marked
+ as an index entry. This is the base service of index marks for <type>DocumentIndex</type>,
+ <type>ContentIndex</type>, and <type>UserIndex</type>.
+ */
+published service BaseIndexMark
+{
+ service com::sun::star::text::TextContent;
+ //-------------------------------------------------------------------------
+
+ /** the string that will be inserted into the corresponding index. If AlternativeText is empty then
+ the string that is marked by the TextRange is inserted into the index.
+ */
+ [property] string AlternativeText;
+};
+
+//=============================================================================
+
+}; }; }; };
+#endif
+
+