LibreOffice
LibreOffice 6.4 SDK API Reference
Public Types | Included Services | Public Attributes | List of all members
TableSortDescriptor Service Referencepublished

contains properties which describe sorting of rows or columns in a table. More...

import"TableSortDescriptor.idl";

Inheritance diagram for TableSortDescriptor:
SortDescriptor XPropertySet XInterface SheetSortDescriptor

Public Types

typedef sequence< com::sun::star::util::SortFieldSortFields
 specifies the descriptions of the individual sort fields. More...
 

Included Services

service com::sun::star::util::SortDescriptor
 contains common sorting properties. More...
 

Public Attributes

long MaxFieldCount
 contains the maximum number of sort fields the descriptor can hold. More...
 
com::sun::star::table::TableOrientation Orientation
 specifies the sorting orientation (sort rows or columns). More...
 
boolean ContainsHeader
 specifies whether the first row or column (depending on com::sun::star::util::SortDescriptor::SortColumns) is a header which should not be sorted. More...
 
- Public Attributes inherited from SortDescriptor
boolean IsCaseSensitive
 specifies if the case of letters is important when comparing entries. More...
 
boolean SortAscending
 specifies the sorting order. More...
 
boolean SortColumns
 specifies if the columns are sorted. More...
 
com::sun::star::lang::Locale CollatorLocale
 specifies the locale for the compare operator (collator). More...
 
string CollatorAlgorithm
 specifies the algorithm for the compare operator (collator). More...
 

Additional Inherited Members

- Exported Interfaces inherited from SortDescriptor
interface com::sun::star::beans::XPropertySet
 
- 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...
 

Detailed Description

contains properties which describe sorting of rows or columns in a table.

It extends the general com::sun::star::util::SortDescriptor with table-specific properties.

Deprecated:

Member Typedef Documentation

◆ SortFields

specifies the descriptions of the individual sort fields.

Exported Interfaces

◆ com::sun::star::util::SortDescriptor

contains common sorting properties.

Member Data Documentation

◆ ContainsHeader

boolean ContainsHeader
property

specifies whether the first row or column (depending on com::sun::star::util::SortDescriptor::SortColumns) is a header which should not be sorted.

◆ MaxFieldCount

long MaxFieldCount
propertyreadonly

contains the maximum number of sort fields the descriptor can hold.

◆ Orientation

specifies the sorting orientation (sort rows or columns).

Some implementations may not support sorting columns.

Deprecated:
use the property com::sun::star::util::SortDescriptor::SortColumns instead.

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