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