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