offapi/com/sun/star/text/TextSortDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_TextSortDescriptor_idl__
  28 #define __com_sun_star_text_TextSortDescriptor_idl__
  29
  30 #ifndef __com_sun_star_util_SortDescriptor_idl__
  31 #include <com/sun/star/util/SortDescriptor.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module text {
  38
  39 //=============================================================================
  40
  41 // DocMerge from xml: service com::sun::star::text::TextSortDescriptor
  42 /** describes sort criteria for sorting text.
  43
  44     @deprecated
  45  */
  46 published service TextSortDescriptor
  47 {
  48     // DocMerge: empty anyway
  49     service com::sun::star::util::SortDescriptor;
  50
  51     //-------------------------------------------------------------------------
  52
  53     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::Delimiter
  54     /** contains the character that marks the separation of columns.
  55      */
  56     [property] char Delimiter;
  57
  58     //-------------------------------------------------------------------------
  59
  60     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::IsSortInTable
  61     /** determines if the content of a table is to be sorted.
  62      */
  63     [property] boolean IsSortInTable;
  64
  65     //-------------------------------------------------------------------------
  66
  67     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::SortRowOrColumnNo0
  68     /** contains the row or column index used in the first search key.
  69      */
  70     [property] long SortRowOrColumnNo0;
  71
  72     //-------------------------------------------------------------------------
  73
  74     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::IsSortNumeric0
  75     /** determines if the sorting in the first search key is done
  76         numeric or alphanumeric order.
  77      */
  78     [property] boolean IsSortNumeric0;
  79
  80     //-------------------------------------------------------------------------
  81
  82     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::IsSortAscending0
  83     /** determines if the sorting in the first search key is done
  84         in ascending or descending order.
  85      */
  86     [property] boolean IsSortAscending0;
  87
  88     //-------------------------------------------------------------------------
  89
  90     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::SortRowOrColumnNo1
  91     /** contains the row or column index used in the second search key.
  92      */
  93     [property] long SortRowOrColumnNo1;
  94
  95     //-------------------------------------------------------------------------
  96
  97     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::IsSortNumeric1
  98     /** determines if the sorting in the second search key is done
  99         in numeric or alphanumeric order.
 100      */
 101     [property] boolean IsSortNumeric1;
 102
 103     //-------------------------------------------------------------------------
 104
 105     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::IsSortAscending1
 106     /** determines if the sorting in the second search key is done
 107         in ascending or descending order.
 108      */
 109     [property] boolean IsSortAscending1;
 110
 111     //-------------------------------------------------------------------------
 112
 113     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::SortRowOrColumnNo2
 114     /** contains the row or column index used in the third search key.
 115      */
 116     [property] long SortRowOrColumnNo2;
 117
 118     //-------------------------------------------------------------------------
 119
 120     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::IsSortNumeric2
 121     /** determines if the sorting in the third search key is done
 122         in numeric or alphanumeric order.
 123      */
 124     [property] boolean IsSortNumeric2;
 125
 126     //-------------------------------------------------------------------------
 127
 128     // DocMerge from xml: property com::sun::star::text::TextSortDescriptor::IsSortAscending2
 129     /** determines if the sorting in the third search key is done
 130         in ascending or descending order.
 131      */
 132     [property] boolean IsSortAscending2;
 133
 134 };
 135
 136 //=============================================================================
 137
 138 }; }; }; };
 139
 140 /*=============================================================================
 141
 142 =============================================================================*/
 143 #endif