LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Modules | Classes | Enumerations
com::sun::star::style Module Reference

Formatting and layout style and style sheet interfaces. More...

Constant Groups

constants CaseMap
 These constants are used to specify a case-related mapping for formatting and displaying characters.
 
constants FootnoteLineStyle
 
constants LineNumberPosition
 These constants are used to specify the position of the numbering of lines.
 
constants LineSpacingMode
 These constants specify the interpretation of LineHeight.
 
constants NumberingType
 These constants are used to specify which numbering style is used.
 
constants ParagraphStyleCategory
 These constants are used to specify the category of paragraph styles in text documents.
 

Classes

service  CellStyle
 is a common service for table cell styles. More...
 
service  CharacterProperties
 This is a set of properties to describe the style of characters. More...
 
service  CharacterPropertiesAsian
 This is a set of properties to describe the style of characters in Asian texts. More...
 
service  CharacterPropertiesComplex
 This is a set of properties to describe the style of characters in complex texts. More...
 
service  CharacterStyle
 specifies a style sheet for characters within a com::sun::star::text::Text. More...
 
struct  DropCapFormat
 This struct describes drop caps at a paragraph object. More...
 
struct  LineSpacing
 This structure is used to specify the height of a text line. More...
 
service  NumberingAlignment
 specify the alignment of a numbering level. More...
 
service  NumberingLevel
 These properties describe the numbering of a paragraph. More...
 
service  NumberingRule
 specifies a rule to format numberings. More...
 
service  PageProperties
 describes the style of pages. More...
 
service  PageStyle
 contributes common properties of page styles. More...
 
service  ParagraphProperties
 describes the style of paragraphs. More...
 
service  ParagraphPropertiesAsian
 contains settings for the style of paragraphs with complex text layout. More...
 
service  ParagraphPropertiesComplex
 contains settings for the style of paragraphs with complex text layout. More...
 
service  ParagraphStyle
 specifies a style sheet for paragraphs within a com::sun::star::text::Text. More...
 
service  Style
 This service specifies a single style sheet. More...
 
service  StyleFamilies
 This service contains the collection of style families within the container document. More...
 
service  StyleFamily
 This service is a container of style sheets of the same style family. More...
 
struct  TabStop
 This structure is used to specify a single tabulator stop. More...
 
interface  XAutoStyle
 This interface allows access to a single automatic style. More...
 
interface  XAutoStyleFamily
 This service contains the collection of automatic style families within the container document. More...
 
interface  XAutoStyles
 This service contains the collection of automatic style families within the container document. More...
 
interface  XAutoStylesSupplier
 This interface provides access to the style families within the container document. More...
 
interface  XDefaultsSupplier
 This interface provides access to an XPropertySet of defaults. More...
 
interface  XStyle
 specifies a template for a style (aka style sheet). More...
 
interface  XStyleFamiliesSupplier
 This interface provides access to the style families within the container document. More...
 
interface  XStyleLoader
 enables the object to import styles from documents. More...
 
interface  XStyleLoader2
 extends XStyleLoader interface to import styles from an already opened component. More...
 
interface  XStyleSupplier
 

Enumerations

enum  BreakType {
  NONE, COLUMN_BEFORE, COLUMN_AFTER, COLUMN_BOTH,
  PAGE_BEFORE, PAGE_AFTER, PAGE_BOTH
}
 These enumeration values are used to specify if and how a page or column break is applied. More...
 
enum  GraphicLocation {
  NONE, LEFT_TOP, MIDDLE_TOP, RIGHT_TOP,
  LEFT_MIDDLE, MIDDLE_MIDDLE, RIGHT_MIDDLE, LEFT_BOTTOM,
  MIDDLE_BOTTOM, RIGHT_BOTTOM, AREA, TILED
}
 These enumeration values are used to specify the location of a graphic object within its surroundings. More...
 
enum  HorizontalAlignment { LEFT, CENTER, RIGHT }
 values specify the horizontal alignment of an object within a container object. More...
 
enum  PageStyleLayout { ALL, LEFT, RIGHT, MIRRORED }
 specifies the pages for which a page layout is valid. More...
 
enum  ParagraphAdjust {
  LEFT, RIGHT, BLOCK, CENTER,
  STRETCH
}
 These enumeration values describe the formatting of a text paragraph. More...
 
enum  TabAlign {
  LEFT, CENTER, RIGHT, DECIMAL,
  DEFAULT
}
 These enumeration values are used to specify the alignment of the text range delimited by a tabulator. More...
 
enum  VerticalAlignment { TOP, MIDDLE, BOTTOM }
 specify the horizontal alignment of an object within a container object. More...
 

Detailed Description

Formatting and layout style and style sheet interfaces.

Enumeration Type Documentation

enum BreakType
published

These enumeration values are used to specify if and how a page or column break is applied.

Developers Guide
Text - Formatting
Enumerator
NONE 

No column or page break is applied.

This value specifies that a location is not yet assigned.

COLUMN_BEFORE 

A column break is applied before the object to which it belongs.

This implies that the object to which it belongs is the first in its column.

COLUMN_AFTER 

A column break is applied after the object to which it belongs.

This implies that the object to which it belongs is the last in its column.

COLUMN_BOTH 

A column break is applied before and after the object to which it belongs.

This implies that this object is the only one in its column.

PAGE_BEFORE 

A page break is applied before the object to which it belongs.

This implies that the object to which it belongs is the first on its page.

PAGE_AFTER 

A page break is applied after the object to which it belongs.

This implies that the object to which it belongs is the last on its page.

PAGE_BOTH 

A page break is applied before and after the object to which it belongs.

This implies that this object is the only one on its page.

enum GraphicLocation
published

These enumeration values are used to specify the location of a graphic object within its surroundings.

Enumerator
NONE 

No column or page break is applied.

This value specifies that a location is not yet assigned.

LEFT_TOP 

The graphic is located in the top left corner.

MIDDLE_TOP 

The graphic is located in the middle of the top edge.

RIGHT_TOP 

The graphic is located in the top right corner.

LEFT_MIDDLE 

The graphic is located in the middle of the left edge.

MIDDLE_MIDDLE 

The graphic is located at the center of the surrounding object.

RIGHT_MIDDLE 

The graphic is located in the middle of the right edge.

LEFT_BOTTOM 

The graphic is located in the bottom left corner.

MIDDLE_BOTTOM 

The graphic is located in the middle of the bottom edge.

RIGHT_BOTTOM 

The graphic is located in the bottom right corner.

AREA 

The graphic is scaled to fill the whole surrounding area.

TILED 

The graphic is repeatedly spread over the surrounding object like tiles.

enum HorizontalAlignment
published

values specify the horizontal alignment of an object within a container object.

Enumerator
LEFT 

set the horizontal alignment to the left margin from the container object

The text range is left-aligned between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the left border

The page style is only used for left pages.

CENTER 

set the horizontal alignment to the center between the margins from the container object

The text range is centered between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the center

RIGHT 

set the horizontal alignment to the right margin from the container object

The text range is right-aligned between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the right border

The page style is only used for right pages.

enum PageStyleLayout
published

specifies the pages for which a page layout is valid.

Enumerator
ALL 

The page style is identically used for left and right pages.

LEFT 

set the horizontal alignment to the left margin from the container object

The text range is left-aligned between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the left border

The page style is only used for left pages.

RIGHT 

set the horizontal alignment to the right margin from the container object

The text range is right-aligned between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the right border

The page style is only used for right pages.

MIRRORED 

The page style is used unchanged for left pages and mirrored for right pages.

enum ParagraphAdjust
published

These enumeration values describe the formatting of a text paragraph.

Enumerator
LEFT 

set the horizontal alignment to the left margin from the container object

The text range is left-aligned between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the left border

The page style is only used for left pages.

RIGHT 

set the horizontal alignment to the right margin from the container object

The text range is right-aligned between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the right border

The page style is only used for right pages.

BLOCK 

adjusted to both borders / stretched, except for last line

CENTER 

set the horizontal alignment to the center between the margins from the container object

The text range is centered between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the center

STRETCH 

adjusted to both borders / stretched, including last line

enum TabAlign
published

These enumeration values are used to specify the alignment of the text range delimited by a tabulator.

Enumerator
LEFT 

set the horizontal alignment to the left margin from the container object

The text range is left-aligned between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the left border

The page style is only used for left pages.

CENTER 

set the horizontal alignment to the center between the margins from the container object

The text range is centered between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the center

RIGHT 

set the horizontal alignment to the right margin from the container object

The text range is right-aligned between the previous tabulator (or the left border, if none) and this tabulator.

adjusted to the right border

The page style is only used for right pages.

DECIMAL 

The decimal point of the text range to the left of this tabulator is aligned to the position of this tabulator.

DEFAULT 

The default alignment for tabulators is applied.

enum VerticalAlignment
published

specify the horizontal alignment of an object within a container object.

Enumerator
TOP 

set the vertical alignment to the center between the top and bottom margins from the container object.

MIDDLE 

set the vertical alignment to the top margin from the container object.

BOTTOM 

set the vertical alignment to the bottom margin from the container object.