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

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