offapi/com/sun/star/ucb/NumberedSortingInfo.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: NumberedSortingInfo.idl,v $
  10  * $Revision: 1.8 $
  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_ucb_NumberedSortingInfo_idl__
  31 #define __com_sun_star_ucb_NumberedSortingInfo_idl_
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module ucb {
  36
  37 //=============================================================================
  38 /** contains information for sorting a <type>ContentResultSet</type>.
  39
  40     <p> In contrast to the struct <type>SortingInfo</type> this struct is
  41     used to be on the safe side, that no one asks for sorting by a property
  42     which is not contained in a <type>ContentResultSet</type>.
  43 */
  44 published struct NumberedSortingInfo
  45 {
  46     //-------------------------------------------------------------------------
  47     /** sort the resultset by this column. Index starts with <code>1</code>.
  48     */
  49     long ColumnIndex;
  50
  51     //-------------------------------------------------------------------------
  52     /** contains a flag indicating the sort mode (ascending or descending).
  53     */
  54     boolean Ascending;
  55 };
  56
  57 //=============================================================================
  58
  59 }; }; }; };
  60
  61 #endif