LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XTextColumns Interface Referencepublished

manages columns within the object. More...

import"XTextColumns.idl";

Inheritance diagram for XTextColumns:
XInterface TextColumns

Public Member Functions

long getReferenceValue ()
 
short getColumnCount ()
 
void setColumnCount ([in] short nColumns)
 sets the number of columns. More...
 
sequence< com::sun::star::text::TextColumngetColumns ()
 returns the column description of the object. More...
 
void setColumns ([in] sequence< com::sun::star::text::TextColumn > Columns)
 sets the descriptors of all columns. 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

manages columns within the object.

The values used are relative. So it is not necessary to know the width of the object. The sum of the relative width values depends on the object and is defined in "ReferenceValue."

Member Function Documentation

◆ getColumnCount()

short getColumnCount ( )
Returns
the number of columns.

◆ getColumns()

sequence<com::sun::star::text::TextColumn> getColumns ( )

returns the column description of the object.

See also
TextColumn

◆ getReferenceValue()

long getReferenceValue ( )
Returns
the sum of all values.

As described above, the width values are relative.

◆ setColumnCount()

void setColumnCount ( [in] short  nColumns)

sets the number of columns.

The minimum is 1 column.

◆ setColumns()

void setColumns ( [in] sequence< com::sun::star::text::TextColumn Columns)

sets the descriptors of all columns.

The number of members in the sequence must be the same as the number of columns of the object.

See also
TextColumn

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