offapi/com/sun/star/text/TextSortDescriptor2.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_TextSortDescriptor2_idl__
  28 #define __com_sun_star_text_TextSortDescriptor2_idl__
  29
  30 #ifndef __com_sun_star_table_TableSortDescriptor2_idl__
  31 #include <com/sun/star/table/TableSortDescriptor2.idl>
  32 #endif
  33 #ifndef __com_sun_star_table_TableSortField_idl__
  34 #include <com/sun/star/table/TableSortField.idl>
  35 #endif
  36 #ifndef __com_sun_star_table_TableSortFieldType_idl__
  37 #include <com/sun/star/table/TableSortFieldType.idl>
  38 #endif
  39
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module text {
  44
  45 //=============================================================================
  46
  47 /** describes sort criterias for sorting paragraphs or table contents in
  48     a text document.
  49
  50     @since OOo 1.1.2
  51  */
  52 published service TextSortDescriptor2
  53 {
  54     service com::sun::star::table::TableSortDescriptor2;
  55
  56     //-------------------------------------------------------------------------
  57     /** determines if the content of a table or a selection of
  58         paragraphs is to be sorted.
  59      */
  60     [property] boolean IsSortInTable;
  61
  62     //-------------------------------------------------------------------------
  63     /** contains the character that marks the column separator
  64         when a selection of paragraphs is to be sorted.
  65      */
  66     [property] char Delimiter;
  67
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 /*=============================================================================
  75
  76 =============================================================================*/
  77 #endif