Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: util ::
interface XSortable
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XSortable
Description makes it possible to sort the contents of this object. The available properties describing the sort criterias are defined in the sort descriptor implemented by the object that implements this interface. There are older deprecated sort descriptors: com::sun::star::util::SortDescriptor com::sun::star::table::TableSortDescriptor com::sun::star::text::TextSortDescriptor And a new set of sort descriptors: com::sun::star::util::SortDescriptor2 com::sun::star::table::TableSortDescriptor2 com::sun::star::text::TextSortDescriptor2 Both types may be implemented by the same object. When calling the sort method however properties from different descriptors must not be mixed. Developers Guide 7.3.1 Text Documents - Working with Text Documents - Word Processing - Sorting Text

Methods' Summary
createSortDescriptor |
sort | sorts the contents of the object according to the specified properties.

Methods' Details
createSortDescriptor
sequence< ::com::sun::star::beans::PropertyValue > createSortDescriptor(); |  |
Returns a sequence of properties which allows to specify/modify the sort criteria. The set of properties is specific to the type of object that implements this interface. Therefore they can usually be used only for objects of that same type. See also SortDescriptor See also ::com::sun::star::table::TableSortDescriptor See also ::com::sun::star::text::TextSortDescriptor See also SortDescriptor2 See also ::com::sun::star::table::TableSortDescriptor2 See also ::com::sun::star::text::TextSortDescriptor2
sort
void sort( | [in] sequence< ::com::sun::star::beans::PropertyValue > | xDescriptor );
Description sorts the contents of the object according to the specified properties. The specified properties are usually the same or a subset of those obtained by calling createSortDescriptor on the same type of object. See also SortDescriptor See also ::com::sun::star::table::TableSortDescriptor See also ::com::sun::star::text::TextSortDescriptor See also SortDescriptor2 See also ::com::sun::star::table::TableSortDescriptor2 See also ::com::sun::star::text::TextSortDescriptor2

Top of Page

Copyright © 2003 Sun Microsystems, Inc.