LibreOffice 6.4 SDK API Reference
Included Services | Public Attributes | List of all members
BaseIndexMark Service Referencepublished

is a TextRange which is explicitly marked as an index entry. More...


Inheritance diagram for BaseIndexMark:
TextContent XTextContent XComponent XInterface ContentIndexMark DocumentIndexMark UserIndexMark

Included Services

service com::sun::star::text::TextContent

Public Attributes

string AlternativeText
 the string that will be inserted into the corresponding index. More...
- Public Attributes inherited from TextContent
com::sun::star::text::TextContentAnchorType AnchorType
 specifies how the text content is attached to its surrounding Text. More...
com::sun::star::text::WrapTextMode TextWrap
 specifies if the text content is a shape and how the text is wrapped around the shape. More...

Additional Inherited Members

- Public Types inherited from TextContent
typedef sequence< com::sun::star::text::TextContentAnchorTypeAnchorTypes
 contains the anchor type of the text content. More...
- Exported Interfaces inherited from TextContent
interface com::sun::star::text::XTextContent
 This interface is used for the attachment of this text content to the surrounding text. More...
- Public Member Functions inherited from XTextContent
void attach ([in] com::sun::star::text::XTextRange xTextRange) raises ( com::sun::star::lang::IllegalArgumentException )
 is called when this object gets embedded in a text. More...
com::sun::star::text::XTextRange getAnchor ()
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
void acquire ()
 increases the reference counter by one. More...
void release ()
 decreases the reference counter by one. More...

Detailed Description

is a TextRange which is explicitly marked as an index entry.

This is the base service of index marks for DocumentIndex, ContentIndex, and UserIndex.

Developers Guide
Text - Indexes and Index Marks - Index marks

Exported Interfaces

◆ com::sun::star::text::TextContent

Member Data Documentation

◆ AlternativeText

string AlternativeText

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.

The documentation for this service was generated from the following file: