specifies the basic service of different indexes within a document. More...

import"BaseIndex.idl";

Inheritance diagram for BaseIndex:

Exported Interfaces
interface	com::sun::star::text::XDocumentIndex

interface	com::sun::star::util::XRefreshable

Public Attributes
string	Title
	contains the title of the index. More...

boolean	IsProtected
	determines if the index is protected. More...

string	ParaStyleHeading
	contains the name of the paragraph style that is applied to the heading. More...

string	ParaStyleLevel1
	contains the name of the paragraph style that is applied to the 1st level. More...

string	ParaStyleLevel2
	contains the name of the paragraph style that is applied to the 2nd level. More...

string	ParaStyleLevel3
	contains the name of the paragraph style that is applied to the 3rd level. More...

string	ParaStyleLevel4
	contains the name of the paragraph style that is applied to the 4th level. More...

string	ParaStyleLevel5
	contains the name of the paragraph style that is applied to the 5th level. More...

string	ParaStyleLevel6
	contains the name of the paragraph style that is applied to the 6th level. More...

string	ParaStyleLevel7
	contains the name of the paragraph style that is applied to the 7th level. More...

string	ParaStyleLevel8
	contains the name of the paragraph style that is applied to the 8th level. More...

string	ParaStyleLevel9
	contains the name of the paragraph style that is applied to the 9th level. More...

string	ParaStyleLevel10
	contains the name of the paragraph style that is applied to the 10th level. More...

string	ParaStyleSeparator
	contains the name of the paragraph style that is applied to the separator level. More...

XTextColumns	TextColumns
	contains the column interface. More...

string	BackGraphicURL
	contains the URL of a graphic file that is displayed as background graphic More...

string	BackGraphicFilter
	contains the name of the filter of the graphic file that is displayed as background graphic More...

com::sun::star::style::GraphicLocation	BackGraphicLocation
	determines the position of the background graphic. More...

com::sun::star::util::Color	BackColor
	specifies the color of the background. More...

boolean	BackTransparent
	If `TRUE`, the background color value in "BackColor" is not visible. More...

com::sun::star::container::XIndexReplace	LevelFormat
	returns the interface of the level format of the index. More...

boolean	CreateFromChapter
	determines if the content of the document index is created from the complete document content or from the current chapter only. More...

com::sun::star::text::XTextSection	ContentSection
	the text section containing the content of the index More...

com::sun::star::text::XTextSection	HeaderSection
	the text section containing the header of the index More...

com::sun::star::graphic::XGraphic	BackGraphic
	contains the graphic object that is displayed as background graphic. More...

Additional Inherited Members
Public Member Functions inherited from XDocumentIndex
string	getServiceName ()
	returns the service name that was used to create this document index type. More...

void	update ()
	initiates an update to the document index. 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...

Protected Member Functions inherited from XRefreshable
void	refresh ()
	refreshes the data of the object from the connected data source. More...

void	addRefreshListener ([in] com::sun::star::util::XRefreshListener l)
	adds the specified listener to receive the event "refreshed." More...

void	removeRefreshListener ([in] com::sun::star::util::XRefreshListener l)
	removes the specified listener. More...

Detailed Description

specifies the basic service of different indexes within a document.

See also: com::sun::star::text::DocumentIndex; com::sun::star::text::ContentIndex; com::sun::star::text::UserDefinedIndex; com::sun::star::text::IllustrationsIndex; com::sun::star::text::TableIndex; com::sun::star::text::ObjectIndex

Developers Guide: Text Documents - Indexes and Index Marks

Exported Interfaces

◆ com::sun::star::text::XDocumentIndex

interface com::sun::star::text::XDocumentIndex

◆ com::sun::star::util::XRefreshable

interface com::sun::star::util::XRefreshable

optional

Since: LibreOffice 4.0

Member Data Documentation

◆ BackColor

com::sun::star::util::Color BackColor

property

specifies the color of the background.

◆ BackGraphic

com::sun::star::graphic::XGraphic BackGraphic

optionalproperty

contains the graphic object that is displayed as background graphic.

Since: LibreOffice 6.1

◆ BackGraphicFilter

string BackGraphicFilter

property

contains the name of the filter of the graphic file that is displayed as background graphic

◆ BackGraphicLocation

com::sun::star::style::GraphicLocation BackGraphicLocation

property

determines the position of the background graphic.

See also: GraphicLocation

◆ BackGraphicURL

string BackGraphicURL

property

contains the URL of a graphic file that is displayed as background graphic

Deprecated:: as of LibreOffice 6.1 - use BackGraphic instead

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the BackGraphic property.

◆ BackTransparent

boolean BackTransparent

property

If TRUE, the background color value in "BackColor" is not visible.

◆ ContentSection

com::sun::star::text::XTextSection ContentSection

property

the text section containing the content of the index

◆ CreateFromChapter

boolean CreateFromChapter

optionalproperty

determines if the content of the document index is created from the complete document content or from the current chapter only.

It is not available in the bibliography

◆ HeaderSection

com::sun::star::text::XTextSection HeaderSection

property

the text section containing the header of the index

◆ IsProtected

boolean IsProtected

property

determines if the index is protected.

◆ LevelFormat

com::sun::star::container::XIndexReplace LevelFormat

optionalproperty

returns the interface of the level format of the index.

The description of the format of the levels depends on the type of the document index.

See also: DocumentIndexLevelFormat

◆ ParaStyleHeading

string ParaStyleHeading

property

contains the name of the paragraph style that is applied to the heading.

◆ ParaStyleLevel1

string ParaStyleLevel1

property

contains the name of the paragraph style that is applied to the 1st level.

◆ ParaStyleLevel10

string ParaStyleLevel10

optionalproperty

contains the name of the paragraph style that is applied to the 10th level.

◆ ParaStyleLevel2

string ParaStyleLevel2

optionalproperty

contains the name of the paragraph style that is applied to the 2nd level.

◆ ParaStyleLevel3

string ParaStyleLevel3

optionalproperty

contains the name of the paragraph style that is applied to the 3rd level.

◆ ParaStyleLevel4

string ParaStyleLevel4

optionalproperty

contains the name of the paragraph style that is applied to the 4th level.

◆ ParaStyleLevel5

string ParaStyleLevel5

optionalproperty

contains the name of the paragraph style that is applied to the 5th level.

◆ ParaStyleLevel6

string ParaStyleLevel6

optionalproperty

contains the name of the paragraph style that is applied to the 6th level.

◆ ParaStyleLevel7

string ParaStyleLevel7

optionalproperty

contains the name of the paragraph style that is applied to the 7th level.

◆ ParaStyleLevel8

string ParaStyleLevel8

optionalproperty

contains the name of the paragraph style that is applied to the 8th level.

◆ ParaStyleLevel9

string ParaStyleLevel9

optionalproperty

contains the name of the paragraph style that is applied to the 9th level.

◆ ParaStyleSeparator

string ParaStyleSeparator

optionalproperty

contains the name of the paragraph style that is applied to the separator level.

◆ TextColumns

XTextColumns TextColumns

property

contains the column interface.

◆ Title

string Title

property

contains the title of the index.

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

com/sun/star/text/BaseIndex.idl

Exported Interfaces

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

◆ com::sun::star::text::XDocumentIndex

◆ com::sun::star::util::XRefreshable

Member Data Documentation

◆ BackColor

◆ BackGraphic

◆ BackGraphicFilter

◆ BackGraphicLocation

◆ BackGraphicURL

◆ BackTransparent

◆ ContentSection

◆ CreateFromChapter

◆ HeaderSection

◆ IsProtected

◆ LevelFormat

◆ ParaStyleHeading

◆ ParaStyleLevel1

◆ ParaStyleLevel10

◆ ParaStyleLevel2

◆ ParaStyleLevel3

◆ ParaStyleLevel4

◆ ParaStyleLevel5

◆ ParaStyleLevel6

◆ ParaStyleLevel7

◆ ParaStyleLevel8

◆ ParaStyleLevel9

◆ ParaStyleSeparator

◆ TextColumns

◆ Title