summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/DocumentIndexMark.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/DocumentIndexMark.idl')
-rw-r--r--offapi/com/sun/star/text/DocumentIndexMark.idl57
1 files changed, 57 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/DocumentIndexMark.idl b/offapi/com/sun/star/text/DocumentIndexMark.idl
new file mode 100644
index 000000000..a62c9f33d
--- /dev/null
+++ b/offapi/com/sun/star/text/DocumentIndexMark.idl
@@ -0,0 +1,57 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_text_DocumentIndexMark_idl__
+#define __com_sun_star_text_DocumentIndexMark_idl__
+
+#include <com/sun/star/text/TextContent.idl>
+#include <com/sun/star/text/BaseIndexMark.idl>
+
+
+
+ module com { module sun { module star { module text {
+
+
+/** is a TextRange which is explicitly marked
+ as an index entry for a DocumentIndex.
+ */
+published service DocumentIndexMark
+{
+ service com::sun::star::text::TextContent;
+
+ service com::sun::star::text::BaseIndexMark;
+
+ /** contains the primary key of the index entry.
+ It is used to build a hierarchical document index.
+ */
+ [property] string PrimaryKey;
+ /** contains the secondary key of the index entry.
+ It is used to build a hierarchical document index.
+ */
+ [property] string SecondaryKey;
+ /** determines if this entry is a main entry. In a document index this entry will
+ be emphasized by assigning a character style to it.
+ */
+ [property] boolean IsMainEntry;
+};
+
+
+}; }; }; };
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */