:: com :: sun :: star ::

module text
Description
Text specific interfaces.

Nested Modules
FieldMaster
textfield
Services
::com::sun::star::text::AccessibleEndnoteView The accessible view of endnotes.
::com::sun::star::text::AccessibleFootnoteView The accessible view of footnotes.
::com::sun::star::text::AccessibleHeaderFooterView The accessible view of headers and footers.
::com::sun::star::text::AccessiblePageView The accessible view of pagees.
::com::sun::star::text::AccessibleParagraphView The accessible view of a paragraph fragment.
::com::sun::star::text::AccessibleTextDocumentPageView The accessible page preview of a text document.
::com::sun::star::text::AccessibleTextDocumentView The accessible view of a text document.
::com::sun::star::text::AccessibleTextEmbeddedObject The accessible view of an inactive embedded object. If an embedded object gets active, the active document gets an accessible object tree of its own. This tree is not a subtree of the object that supports this service but of the document service itself. The tree exist only until the ovject is deactivated.
::com::sun::star::text::AccessibleTextFrameView The accessible view of text frames.
::com::sun::star::text::AccessibleTextGraphicObject The accessible view of graphics.
::com::sun::star::text::AdvancedTextDocument [ DEPRECATED ]
An advanced text document is an extension of a hypertext document which can also contain text-frames, foot- and endnotes, and some other advanced contents.
::com::sun::star::text::AutoTextContainer provides access to groups of text blocks.
::com::sun::star::text::AutoTextEntry provides access to a text block in a group of an ::com::sun::star::text::AutoTextContainer .
::com::sun::star::text::AutoTextGroup provides access to text blocks in a group.
::com::sun::star::text::BaseFrame specifies the base service of text frames, graphic objects, and embedded objects
::com::sun::star::text::BaseFrameProperties specifies the properties that are provided by all text frames, graphic objects, embedded objects and frame styles.
::com::sun::star::text::BaseIndex specifies the basic service of different indexes within a document.
::com::sun::star::text::BaseIndexMark is a ::com::sun::star::text::TextRange which is explicitly marked as an index entry. This is the base service of index marks for ::com::sun::star::text::DocumentIndex , ::com::sun::star::text::ContentIndex , and ::com::sun::star::text::UserIndex .
::com::sun::star::text::Bibliography specifies service of bibliography within a text document.
::com::sun::star::text::Bookmark A bookmark is a ::com::sun::star::text::TextContent , which is like a jump target or a label.
::com::sun::star::text::Bookmarks This service specifies a collection of ::com::sun::star::text::Bookmark s.
::com::sun::star::text::Cell represents a singe cell within a text table.
::com::sun::star::text::CellProperties service that holds all cell properties of a text table cell in a text document.
::com::sun::star::text::CellRange area of cells within a text table.
::com::sun::star::text::ChainedTextFrame extends a ::com::sun::star::text::TextFrame which shares the same ::com::sun::star::text::Text with other ::com::sun::star::text::ChainedTextFrame instances that will make the text flow through the chained frames. The text flows in the next frame if there is no space left in the current frame.
::com::sun::star::text::ChapterNumberingRule describes the rules for chapter numbering in a text document.
::com::sun::star::text::ContentIndex specifies service of content indexes within a document.
::com::sun::star::text::ContentIndexMark is a ::com::sun::star::text::TextRange which is explicitly marked as an index entry for a ::com::sun::star::text::ContentIndex .
::com::sun::star::text::DefaultNumberingProvider
::com::sun::star::text::Defaults provides default settings of a text component for paragraph and character properties.
::com::sun::star::text::DependentTextField is a ::com::sun::star::text::TextField which is not specified by itself, but dependent on a ::com::sun::star::text::TextFieldMaster .
::com::sun::star::text::DocumentIndex specifies service of content indexes within a document.
::com::sun::star::text::DocumentIndexFormat [ DEPRECATED ]
specifies the formatting of document indexes.
::com::sun::star::text::DocumentIndexLevelFormat This service provides access to the structure of the levels of document indexes.
::com::sun::star::text::DocumentIndexMark is a ::com::sun::star::text::TextRange which is explicitly marked as an index entry for a ::com::sun::star::text::DocumentIndex .
::com::sun::star::text::DocumentIndexMarkAsian is a ::com::sun::star::text::TextRange which is explicitly marked as an index entry for a ::com::sun::star::text::DocumentIndex . 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.
::com::sun::star::text::DocumentIndexParagraphStyles provides access to the names of paragraph styles that are included in content indexes of user defined indexes. The element type is sequence of string.
::com::sun::star::text::DocumentIndexes provides access to all indexes in a document.
::com::sun::star::text::DocumentSettings describes properties that apply to the whole text document.
::com::sun::star::text::Endnote This service specifies a an endnote in a ::com::sun::star::text::TextDocument .
::com::sun::star::text::EndnoteSettings provides access to the settings of footnotes or endnotes in a (text) document.
::com::sun::star::text::Footnote This service specifies a footnote or an endnote in a ::com::sun::star::text::TextDocument .
::com::sun::star::text::FootnoteSettings provides access to the settings of footnotes or endnotes in a (text) document.
::com::sun::star::text::Footnotes provides access to the footnotes or endnotes of a (text) document.
::com::sun::star::text::GenericTextDocument A text document is a model component which contains text structured by paragraphs.
::com::sun::star::text::GlobalDocument Specify the document service of the global text module.
::com::sun::star::text::GlobalSettings specifies a service that provides acces to the settings of a text module.
::com::sun::star::text::HypertextDocument [ DEPRECATED ]
is an extension of a text document which can also contain tables and certain kinds of embedded objects (e.g., graphics).
::com::sun::star::text::IllustrationIndex specifies service of illustration indexes within a document.
::com::sun::star::text::LineNumberingProperties provides access to the settings of the line numbering.
::com::sun::star::text::LineNumberingSettings [ DEPRECATED ]
provides access to the settings of the line numbering.
::com::sun::star::text::MailMerge Gives access to mail merge functionality.
::com::sun::star::text::NumberingLevel provides access to a numbering level as part of the Numbering Rules.
::com::sun::star::text::NumberingRules provides access to the numbering rules.
::com::sun::star::text::NumberingStyle specifies a stylesheet numberings within a ::com::sun::star::text::Text .
::com::sun::star::text::ObjectIndex specifies service of object indexes within a document.
::com::sun::star::text::PageFootnoteInfo specifies the properties of the footnote area of a page or a page style.
::com::sun::star::text::PagePrintSettings These properties describe the way the ::com::sun::star::text::XPagePrintable interface prints the page on one printer page.
::com::sun::star::text::Paragraph is a piece of text which can take its own paragraph-specific attributes (technically, properties).
::com::sun::star::text::ParagraphEnumeration provides access to the paragraphs of an ::com::sun::star::text::XText interface.
::com::sun::star::text::PrintPreviewSettings These properties describe the printing of the content of a text document.
::com::sun::star::text::PrintSettings These properties describe the printing of the content of a text document.
::com::sun::star::text::RedlinePortion A RedlinePortion is a TextPortion that marks a change that has been recorded by the change tracking.
::com::sun::star::text::ReferenceMark is used for cross references in text documents.
::com::sun::star::text::ReferenceMarks provides access to the reference marks in a document.
::com::sun::star::text::Shape specifies the service of shapes in a text document
::com::sun::star::text::TableColumns represents a collection of all columns of a table.
::com::sun::star::text::TableIndex specifies service of table indexes within a document.
::com::sun::star::text::TableRows represents a collection of all rows of a text table.
::com::sun::star::text::Text is an independent piece of text which consists of a series of one or more paragraphs.
::com::sun::star::text::TextColumns provides access to columns in text (e.g., in TextFrames ).
::com::sun::star::text::TextContent is an object which can be anchored in a text, like instances of ::com::sun::star::text::TextFrame or ::com::sun::star::text::TextFields .
::com::sun::star::text::TextContentCollection Objects of this type are collections of text contents of the same type.
::com::sun::star::text::TextCursor A ::com::sun::star::text::TextCursor is a ::com::sun::star::text::TextRange which can be moved within a ::com::sun::star::drawing::Text object.
::com::sun::star::text::TextDocument Specify the document service of the text module.
::com::sun::star::text::TextDocumentView specifies the view of a ::com::sun::star::text::TextDocument .
::com::sun::star::text::TextEmbeddedObject provides access to the properties and methods of an embedded object.
::com::sun::star::text::TextEmbeddedObjects provides access to all embedded objects in a document.
::com::sun::star::text::TextField A ::com::sun::star::form::component::TextField is a ::com::sun::star::text::TextContent which fades its textual representation into the text range to which it is anchored.
::com::sun::star::text::TextFieldEnumeration This interface creates an enumeration of all text fields within a text document.
::com::sun::star::text::TextFieldMaster A ::com::sun::star::text::TextFieldMaster specifies important data for its ::com::sun::star::text::DependentTextField s.
::com::sun::star::text::TextFieldMasters This is a collection of instances of ::com::sun::star::text::TextFieldMaster , defined in a context (e.g. in a document).
::com::sun::star::text::TextFields This is a collection of ::com::sun::star::form::component::TextField instances.
::com::sun::star::text::TextFrame specifies a rectangular shape which contains a ::com::sun::star::drawing::Text object and is attached to a piece of surrounding ::com::sun::star::drawing::Text .
::com::sun::star::text::TextFrames This is the collection of all ::com::sun::star::text::TextFrame instances within a context (e.g. a document).
::com::sun::star::text::TextGraphicObject specifies a graphic which can be embedded in ::com::sun::star::drawing::Text .
::com::sun::star::text::TextGraphicObjects This is the collection of all ::com::sun::star::text::TextGraphicObject instances within a context (e.g. a document).
::com::sun::star::text::TextLayoutCursor A ::com::sun::star::text::TextLayoutCursor is a ::com::sun::star::text::TextRange which can travel within a layout of a ::com::sun::star::drawing::Text object.
::com::sun::star::text::TextPageStyle represents a page style for a text document.
::com::sun::star::text::TextPortion A TextPortion is a piece of text within a paragraph that does not contain changes of its attributes inside.
::com::sun::star::text::TextPortionEnumeration This interface creates an enumeration of paragraph within a text document. The elements created by this enumeration contains either parts of text with equal properties or text content elements like text fields, reference marks or bookmarks.
::com::sun::star::text::TextRange points to a sequence of characters within a ::com::sun::star::text::Text .
::com::sun::star::text::TextRanges provides a container for ::com::sun::star::text::XTextRange objects.
::com::sun::star::text::TextSection A ::com::sun::star::text::TextSection is a range of complete paragraphs within a text. @
::com::sun::star::text::TextSections provides access to the text sections in a text document.
::com::sun::star::text::TextSortDescriptor [ DEPRECATED ]
describes sort criteria for sorting text.
::com::sun::star::text::TextSortDescriptor2 describes sort criterias for sorting paragraphs or table contents in a text document.
::com::sun::star::text::TextSortable [ DEPRECATED ]
provides an interface for sorting.
::com::sun::star::text::TextTable is a table of text cells which is anchored to a surrounding text.
::com::sun::star::text::TextTableCursor specifies a cursor in text tables.
::com::sun::star::text::TextTableRow specifies the properties of a text table row.
::com::sun::star::text::TextTables provides access to all tables in a document.
::com::sun::star::text::TextViewCursor A ::com::sun::star::text::TextViewCursor is a ::com::sun::star::text::TextRange which can travel within a view of a ::com::sun::star::drawing::Text object.
::com::sun::star::text::UserDefinedIndex specifies service of user defined indexes within a document.
::com::sun::star::text::UserIndex specifies service of user defined indexes within a document.
::com::sun::star::text::UserIndexMark is a ::com::sun::star::text::TextRange which is explicitly marked as an index entry for a ::com::sun::star::text::UserIndex .
::com::sun::star::text::ViewSettings provides access to the settings of the controller of a text document.
::com::sun::star::text::WebDocument Specify the document service of the web module.
Interfaces
::com::sun::star::text::XAutoTextContainer handles blocks of ::com::sun::star::text::AutoTextEntry .
::com::sun::star::text::XAutoTextEntry [ DEPRECATED ]
identifies an autotext entry.
::com::sun::star::text::XAutoTextGroup The interface provide methods to insert, rename and delete autotext entries from the current autotext group.
::com::sun::star::text::XBookmarkInsertTool offers an easy way to insert bookmarks by name.
::com::sun::star::text::XBookmarksSupplier provides access to the collection of all bookmarks within this text container.
::com::sun::star::text::XChapterNumberingSupplier contains the settings of the chapter numbering in a text document.
::com::sun::star::text::XDefaultNumberingProvider provides access to default ::com::sun::star::text::NumberingRules according to a given locale information.
::com::sun::star::text::XDependentTextField makes it possible to attach this ::com::sun::star::text::TextField to a ::com::sun::star::text::TextFieldMaster .
::com::sun::star::text::XDocumentIndex [ DEPRECATED ]
This is the main interface for a document index.
::com::sun::star::text::XDocumentIndexMark gives access to the mark of a document index entry.
::com::sun::star::text::XDocumentIndexesSupplier gives access to the collection of document indexes.
::com::sun::star::text::XEndnotesSettingsSupplier makes it possible to access the ::com::sun::star::text::FootnoteSettings within the context (e.g. document).
::com::sun::star::text::XEndnotesSupplier makes it possible to access the endnotes within the context (e.g. document).
::com::sun::star::text::XFootnote specifies a footnote within a Text.
::com::sun::star::text::XFootnotesSettingsSupplier makes it possible to access the ::com::sun::star::text::FootnoteSettings with the context (e.g. document).
::com::sun::star::text::XFootnotesSupplier makes it possible to access the footnotes within the context (e.g. document).
::com::sun::star::text::XHeaderFooter [ DEPRECATED ]
::com::sun::star::text::XHeaderFooterPageStyle [ DEPRECATED ]
::com::sun::star::text::XLineNumberingProperties contains the settings of the line numbering in a text document.
::com::sun::star::text::XLineNumberingSupplier [ DEPRECATED ]
contains the settings of the line numbering in a text document.
::com::sun::star::text::XMailMergeBroadcaster allows for adding/removing of mail merge event listeners.
::com::sun::star::text::XMailMergeListener used to notify listeners about mail merge events.
::com::sun::star::text::XModule [ DEPRECATED ]
::com::sun::star::text::XNumberingFormatter supports the formatting of numberings in various language environments.
::com::sun::star::text::XNumberingRulesSupplier This interface enables the object to handle numbering rules.
::com::sun::star::text::XNumberingTypeInfo provides access to the numbering types that are supported by a component.
::com::sun::star::text::XPageCursor makes it possible to perform cursor movements between pages.
::com::sun::star::text::XPagePrintable Print several pages on one printer page.
::com::sun::star::text::XParagraphCursor makes it possible to move paragraph by paragraph.
::com::sun::star::text::XReferenceMarksSupplier provides access to the reference marks within this context (i.e. document).
::com::sun::star::text::XRelativeTextContentInsert [ DEPRECATED ]
makes it possible to insert new text contents before or after existing text contents.
::com::sun::star::text::XRelativeTextContentRemove [ DEPRECATED ]
makes it possible to remove text contents before or after existing text contents.
::com::sun::star::text::XRubySelection This interface enables the object to handle list of ruby lines (aka Furigana lines).
::com::sun::star::text::XSentenceCursor makes it possible to perform cursor movements through sentences.
::com::sun::star::text::XSimpleText is the main interface for a distinct text unit, i.e. the main text of a document, the text for headers and footers or for single cells of a table.
::com::sun::star::text::XText extends a ::com::sun::star::text::XSimpleText by the capability of inserting ::com::sun::star::text::XTextContent s.
::com::sun::star::text::XTextColumns manages columns within the object.
::com::sun::star::text::XTextContent enables objects to be inserted into a text and to provide their location in a text once they are inserted into it.
::com::sun::star::text::XTextCursor extends a text range by method to modify its position.
::com::sun::star::text::XTextDocument is the main interface of a text document.
::com::sun::star::text::XTextEmbeddedObject [ DEPRECATED ]
f t!
::com::sun::star::text::XTextEmbeddedObjectsSupplier provides the collection of all embedded objects within this context (i.e. this document).
::com::sun::star::text::XTextField is the base interface for all text fields.
::com::sun::star::text::XTextFieldsSupplier makes it possible to access the text fields used in this context (e.g. this document).
::com::sun::star::text::XTextFrame provides access to the ::com::sun::star::drawing::Text of a ::com::sun::star::text::TextFrame .
::com::sun::star::text::XTextFramesSupplier makes it possible to access the ::com::sun::star::text::TextFrame instances in this context (e.g. document).
::com::sun::star::text::XTextGraphicObjectsSupplier provides access to the collection of all embedded and linked graphics within this context (i.e. within this document).
::com::sun::star::text::XTextRange describes the object's position in a text.
::com::sun::star::text::XTextRangeCompare compares the positions of two ::com::sun::star::text::TextRange s within a ::com::sun::star::text::Text .
::com::sun::star::text::XTextRangeMover makes it possible to move a text range (e.g. a paragraph by itself) within this text.
::com::sun::star::text::XTextSection provide special data of a ::com::sun::star::text::TextSection .
::com::sun::star::text::XTextSectionsSupplier manages the text sections within the context (i.e. the document).
::com::sun::star::text::XTextShapesSupplier provides the collection of ::com::sun::star::drawing::TextShape s.
::com::sun::star::text::XTextTable manages a text table.
::com::sun::star::text::XTextTableCursor The TextTableCursor provide methods to navigate throught the table structure, to merge and split cells
::com::sun::star::text::XTextTablesSupplier enables the object to handle text tables.
::com::sun::star::text::XTextViewCursor describes a cursor in a text document's view.
::com::sun::star::text::XTextViewCursorSupplier supplies access to the cursor in the view.
::com::sun::star::text::XWordCursor makes it possible to move a cursor word by word.
Structs
::com::sun::star::text::GraphicCrop describes the cropping of graphic objects. Cropping means to show only parts of the object.
::com::sun::star::text::HoriOrientationFormat describes the horizontal orientation of an object.
::com::sun::star::text::MailMergeEvent represents a mail merge event.
::com::sun::star::text::SectionFileLink describes the link for a text section.
::com::sun::star::text::TableColumnSeparator The width of the cells of a text table is defined by the position of the separator between neighboring cells.
::com::sun::star::text::TextColumn defines a single text column.
::com::sun::star::text::VertOrientationFormat describes the vertical orientation of an object.
Exceptions
::com::sun::star::text::InvalidTextContentException is thrown whenever a method gets a ::com::sun::star::text::TextContent as an actual argument when the text content cannot be used for that operation.
Enums
::com::sun::star::text::HorizontalAdjust enumeration values define the horizontal adjustments of objects.
::com::sun::star::text::NotePrintMode enumeration values are used to define the printing of notes in a document.
::com::sun::star::text::PageNumberType determines which page number is displayed in a page number text field.
::com::sun::star::text::RubyAdjust These enumeration values describe the adjustment of ruby text.
::com::sun::star::text::TextContentAnchorType specify how the text content is attached to its surrounding text.
::com::sun::star::text::WrapTextMode enumeration values specify the text wrap around objects in a text.
::com::sun::star::text::WritingMode this enum covers the different writing directions
Typedefs
::com::sun::star::text::TextColumnSequence
Constant Groups
::com::sun::star::text::AuthorDisplayFormat These constants are used to specify which parts of an author name are displayed in a field.
::com::sun::star::text::BibliographyDataField These values define parts of bibliographic data. They are used to create a bibliography in a text document.
::com::sun::star::text::BibliographyDataType These values define the type of bibliographic data like book, journal, magazine, etc.
::com::sun::star::text::ChapterFormat These constants define the display format of the chapter number in a chapter text field.
::com::sun::star::text::CharacterCompressionType These constants define character compression in asian text.
::com::sun::star::text::ControlCharacter These constants are the codes for inserting control characters using XSimpleText::insertControlCharacter interface.
::com::sun::star::text::DateDisplayFormat [ DEPRECATED ]
This constants define how a date field is formated before it is displayed. The format may also depend on the system or document locale. The samples are in German.
::com::sun::star::text::DocumentStatistic These constants are used to specify the type of a document statistic field.
::com::sun::star::text::FilenameDisplayFormat These constants are used to specify which parts of an URL are displayed in a field.
::com::sun::star::text::FontEmphasis Determins the type and position of an emphasis mark in asian texts.
::com::sun::star::text::FontRelief Determins the relief type of a font.
::com::sun::star::text::FootnoteNumbering These constants are used to specify the footnote numbering.
::com::sun::star::text::HoriOrientation These enumeration values specify the horizontal orientation.
::com::sun::star::text::MailMergeType Defines the possible output types/devices for mail merge.
::com::sun::star::text::ParagraphVertAlign These enumeration values are used to specify the vertical alignment of paragaphs.
::com::sun::star::text::PlaceholderType These constants define how the place-holder text fields act in a document.
::com::sun::star::text::PositionLayoutDir These values specify the layout direction, in which the position attributes of a shape are given
::com::sun::star::text::ReferenceFieldPart These constants define how the reference position is displayed in reference text fields.
::com::sun::star::text::ReferenceFieldSource These constants define the type of the source of a reference field.
::com::sun::star::text::RelOrientation These values define the reference position of relative orientations.
::com::sun::star::text::SetVariableType These constants define the type of a variable text field.
::com::sun::star::text::SizeType The height value of objects like text frames or table rows may be interpreted in different ways.
::com::sun::star::text::TemplateDisplayFormat These constants are used to specify which information about a template is displayed in a field.
::com::sun::star::text::TextGridMode this set of constants describes different modes for text grids
::com::sun::star::text::TimeDisplayFormat [ DEPRECATED ]
This constants define how a time field is formated before it is displayed. The formate may also depend on the system or document locale.
::com::sun::star::text::UserDataPart These constants define which part of the user data is displayed in a user data text field (service "sun.one.text.TextField.ExtendedUser")
::com::sun::star::text::UserFieldFormat These constants describe how the content of a user text field is formatted.
::com::sun::star::text::VertOrientation These enumeration values are used to specify the vertical orientation.
::com::sun::star::text::WrapInfluenceOnPosition These values specify the influence of the wrapping style of a floating screen object when it's positioned.
::com::sun::star::text::WritingMode2 this set of constants describes different writing directions, and * also allows for a value 'PAGE' which causes the writing mode to be * obtained from the current page.
Top of Page