LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
Title Service Reference

import"Title.idl";

Inheritance diagram for Title:
ParagraphProperties FillProperties LineProperties PropertySet XTitle XPropertySet XFastPropertySet XMultiPropertySet XPropertyAccess XPropertyState XInterface XInterface XInterface XInterface XInterface XInterface

Included Services

service ::com::sun::star::style::ParagraphProperties
 only mandatory properties More...
 
service ::com::sun::star::drawing::FillProperties
 
service ::com::sun::star::drawing::LineProperties
 
service ::com::sun::star::beans::PropertySet
 

Exported Interfaces

interface XTitle
 
- Exported Interfaces inherited from PropertySet
interface com::sun::star::beans::XPropertySet
 
interface com::sun::star::beans::XFastPropertySet
 
interface com::sun::star::beans::XMultiPropertySet
 
interface com::sun::star::beans::XPropertyAccess
 
interface com::sun::star::beans::XPropertyState
 

Public Attributes

double TextRotation
 the rotation of the title's text in degrees in the range [0,360). More...
 
boolean StackCharacters
 writes the characters of the title on top of each other if set to TRUE. More...
 
::com::sun::star::chart2::RelativePosition RelativePosition
 The position is a relative position on the page. More...
 
com::sun::star::awt::Size ReferencePageSize
 contains the size of the page at the time when properties were set (e.g. More...
 
- Public Attributes inherited from ParagraphProperties
com::sun::star::style::ParagraphAdjust ParaAdjust
 determines the adjustment of a paragraph. More...
 
com::sun::star::style::LineSpacing ParaLineSpacing
 contains the type of the line spacing of a paragraph. More...
 
com::sun::star::util::Color ParaBackColor
 contains the paragraph background color. More...
 
boolean ParaBackTransparent
 This value is TRUE if the paragraph background color is set to transparent. More...
 
string ParaBackGraphicURL
 contains the value of a link for the background graphic of a paragraph. More...
 
string ParaBackGraphicFilter
 contains the name of the graphic filter for the background graphic of a paragraph. More...
 
com::sun::star::style::GraphicLocation ParaBackGraphicLocation
 contains the value for the position of a background graphic. More...
 
short ParaLastLineAdjust
 determines the adjustment of the last line. More...
 
boolean ParaExpandSingleWord
 determines if single words are stretched. More...
 
long ParaLeftMargin
 determines the left margin of the paragraph in 100th mm. More...
 
long ParaRightMargin
 determines the right margin of the paragraph in 100th mm. More...
 
long ParaTopMargin
 determines the top margin of the paragraph in 100th mm. More...
 
long ParaBottomMargin
 determines the bottom margin of the paragraph in 100th mm. More...
 
boolean ParaContextMargin
 determines if contextual spacing is used. More...
 
sequence< com::sun::star::beans::PropertyValueParaInteropGrabBag
 Grab bag of paragraph properties, used as a string-any map for interim interop purposes. More...
 
boolean ParaLineNumberCount
 determines if the paragraph is included in the line numbering. More...
 
long ParaLineNumberStartValue
 contains the start value for the line numbering. More...
 
string PageDescName
 If this property is set, it creates a page break before the paragraph it belongs to and assigns the value as the name of the new page style sheet to use. More...
 
short PageNumberOffset
 If a page break property is set at a paragraph, this property contains the new value for the page number. More...
 
boolean ParaRegisterModeActive
 determines if the register mode is applied to a paragraph. More...
 
sequence< com::sun::star::style::TabStopParaTabStops
 specifies the positions and kinds of the tab stops within this paragraph. More...
 
string ParaStyleName
 contains the name of the current paragraph style. More...
 
string PageStyleName
 contains the name of the current page style. More...
 
com::sun::star::style::DropCapFormat DropCapFormat
 specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted. More...
 
boolean DropCapWholeWord
 specifies if the property DropCapFormat is applied to the whole first word. More...
 
boolean ParaKeepTogether
 Setting this property to TRUE prevents page or column breaks between this and the following paragraph. More...
 
boolean ParaSplit
 Setting this property to FALSE prevents the paragraph from getting split into two pages or columns. More...
 
short NumberingLevel
 specifies the numbering level of the paragraph. More...
 
com::sun::star::container::XIndexReplace NumberingRules
 contains the numbering rules applied to this paragraph. More...
 
short NumberingStartValue
 specifies the start value for numbering if a new numbering starts at this paragraph. More...
 
boolean ParaIsNumberingRestart
 determines if the numbering rules restart, counting at the current paragraph. More...
 
string NumberingStyleName
 specifies the name of the style for the numbering. More...
 
byte ParaOrphans
 specifies the minimum number of lines of the paragraph that have to be at bottom of a page if the paragraph is spread over more than one page. More...
 
byte ParaWidows
 specifies the minimum number of lines of the paragraph that have to be at top of a page if the paragraph is spread over more than one page. More...
 
com::sun::star::table::ShadowFormat ParaShadowFormat
 determines the type, color, and size of the shadow. More...
 
com::sun::star::table::BorderLine LeftBorder
 contains the left border of the object. More...
 
com::sun::star::table::BorderLine RightBorder
 contains the right border of the object. More...
 
com::sun::star::table::BorderLine TopBorder
 contains the top border of the object. More...
 
com::sun::star::table::BorderLine BottomBorder
 contains the bottom border of the object. More...
 
long BorderDistance
 contains the distance from the border to the object. More...
 
long LeftBorderDistance
 contains the distance from the left border to the object. More...
 
long RightBorderDistance
 contains the distance from the right border to the object. More...
 
long TopBorderDistance
 contains the distance from the top border to the object. More...
 
long BottomBorderDistance
 contains the distance from the bottom border to the object. More...
 
com::sun::star::style::BreakType BreakType
 determines the type of break that is applied at the beginning of the table. More...
 
string DropCapCharStyleName
 specifies the character style name for drop caps. More...
 
long ParaFirstLineIndent
 specifies the indent for the first line. More...
 
boolean ParaIsAutoFirstLineIndent
 determines if the first line should be indented automatically. More...
 
boolean ParaIsHyphenation
 specifies if automatic hyphenation is applied. More...
 
short ParaHyphenationMaxHyphens
 specifies the maximum number of consecutive hyphens. More...
 
short ParaHyphenationMaxLeadingChars
 specifies the maximum number of characters to remain before the hyphen character (when hyphenation is applied). More...
 
short ParaHyphenationMaxTrailingChars
 specifies the maximum number of characters to remain after the hyphen character (when hyphenation is applied). More...
 
short ParaVertAlignment
 specifies the vertical alignment of a paragraph. More...
 
com::sun::star::container::XNameContainer ParaUserDefinedAttributes
 this property stores xml attributes. More...
 
boolean NumberingIsNumber
 returns FALSE if the paragraph is part of a numbering, but has no numbering label. More...
 
boolean ParaIsConnectBorder
 the property determines if borders set at a paragraph are merged with the next paragraph. More...
 
string ListId
 specifies the id of the list to which the paragraph belongs More...
 
short OutlineLevel
 specifies the outline level to which the paragraph belongs More...
 
com::sun::star::graphic::XGraphic ParaBackGraphic
 contains the graphic for the background of a paragraph. More...
 
- Public Attributes inherited from FillProperties
FillStyle FillStyle
 This enumeration selects the style the area will be filled with. More...
 
com::sun::star::util::Color FillColor
 If the property FillStyle is set to FillStyle::SOLID, this is the color used. More...
 
short FillTransparence
 This is the transparence of the filled area. More...
 
string FillTransparenceGradientName
 If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty. More...
 
com::sun::star::awt::Gradient FillTransparenceGradient
 This describes the transparency of the fill area as a gradient. More...
 
string FillGradientName
 If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style. More...
 
com::sun::star::awt::Gradient FillGradient
 If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used. More...
 
string FillHatchName
 If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style. More...
 
Hatch FillHatch
 If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used. More...
 
boolean FillBackground
 if this is TRUE, the transparent background of a hatch filled area is drawn in the current background color. More...
 
string FillBitmapName
 If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style. More...
 
com::sun::star::awt::XBitmap FillBitmap
 If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used. More...
 
string FillBitmapURL
 If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used. More...
 
short FillBitmapPositionOffsetX
 This is the horizontal offset where the tile starts. More...
 
short FillBitmapPositionOffsetY
 This is the vertical offset where the tile starts. More...
 
short FillBitmapOffsetX
 Every second line of tiles is moved the given percent of the width of the bitmap. More...
 
short FillBitmapOffsetY
 Every second row of tiles is moved the given percent of the height of the bitmap. More...
 
RectanglePoint FillBitmapRectanglePoint
 The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering. More...
 
boolean FillBitmapLogicalSize
 specifies if the size is given in percentage or as an absolute value. More...
 
long FillBitmapSizeX
 This is the width of the tile for filling. More...
 
long FillBitmapSizeY
 This is the height of the tile for filling. More...
 
BitmapMode FillBitmapMode
 this enum selects how a area is filled with a single bitmap. More...
 
boolean FillBitmapStretch
 if set, the fill bitmap is stretched to fill the area of the shape. More...
 
boolean FillBitmapTile
 if set, the fill bitmap is repeated to fill the area of the shape. More...
 
com::sun::star::text::GraphicCrop GraphicCrop
 contains the cropping of the object. More...
 
- Public Attributes inherited from LineProperties
com::sun::star::drawing::LineStyle LineStyle
 This property contains the type of the line. More...
 
com::sun::star::drawing::LineDash LineDash
 This property contains the dash of the line. More...
 
string LineDashName
 This property contains the name of the dash of the line. More...
 
com::sun::star::util::Color LineColor
 This property contains the line color. More...
 
short LineTransparence
 This property contains the extent of transparency. More...
 
long LineWidth
 This property contains the width of the line in 1/100th mm. More...
 
com::sun::star::drawing::LineJoint LineJoint
 This property defines the rendering of joints between thick lines. More...
 
com::sun::star::drawing::LineCap LineCap
 This property defines the rendering of ends of thick lines. More...
 
string LineStartName
 This property contains the name of the line start poly polygon Bezier. More...
 
string LineEndName
 This property contains the name of the line end poly polygon Bezier. More...
 
com::sun::star::drawing::PolyPolygonBezierCoords LineStart
 This property contains the line start in the form of a poly polygon Bezier. More...
 
com::sun::star::drawing::PolyPolygonBezierCoords LineEnd
 This property contains the line end in the form of a poly polygon Bezier. More...
 
boolean LineStartCenter
 If this property is TRUE, the line will start from the center of the polygon. More...
 
long LineStartWidth
 This property contains the width of the line start polygon. More...
 
boolean LineEndCenter
 If this property is TRUE, the line will end in the center of the polygon. More...
 
long LineEndWidth
 This property contains the width of the line end polygon. More...
 

Additional Inherited Members

- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener 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...
 
- Public Member Functions inherited from XTitle
sequence< XFormattedStringgetText ()
 
void setText ([in] sequence< XFormattedString > Strings)
 
- Protected Member Functions inherited from XFastPropertySet
void setFastPropertyValue ([in] long nHandle, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value to the property with the specified name. More...
 
any getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- Protected Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values to the properties with the specified names. More...
 
sequence< any > getPropertyValues ([in] sequence< string > aPropertyNames)
 
void addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 adds an XPropertiesChangeListener to the specified property with the specified names. More...
 
void removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
 removes an XPropertiesChangeListener from the listener list. More...
 
void firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 fires a sequence of PropertyChangeEvents to the specified listener. More...
 
- Protected Member Functions inherited from XPropertyAccess
sequence< com::sun::star::beans::PropertyValuegetPropertyValues ()
 
void setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values of given properties. More...
 
- Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 Sets the property to default value. More...
 
any getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 

Exported Interfaces

only mandatory properties

Exported Interfaces

interface XTitle

Member Data Documentation

com::sun::star::awt::Size ReferencePageSize
propertymaybevoid

contains the size of the page at the time when properties were set (e.g.

the CharHeight).

This way it is possible to resize objects (like text) in the view without modifying the model.

The position is a relative position on the page.

If a relative position is given the title is not automatically placed, but instead is placed relative on the page.

boolean StackCharacters
property

writes the characters of the title on top of each other if set to TRUE.

double TextRotation
property

the rotation of the title's text in degrees in the range [0,360).


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