offapi/com/sun/star/ucb/SearchRecursion.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: SearchRecursion.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_ucb_SearchRecursion_idl__
  31 #define __com_sun_star_ucb_SearchRecursion_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module ucb {
  37
  38 //=============================================================================
  39 /** the various modes of recursion when searching through a hierachical
  40     object.
  41
  42     @see SearchInfo
  43 */
  44 published enum SearchRecursion
  45 {
  46     //-------------------------------------------------------------------------
  47     /** Does not search through any sub-objects.
  48     */
  49     NONE,
  50
  51     //-------------------------------------------------------------------------
  52     /** Only searches through sub-objects of the first hierarchy level.
  53     */
  54     ONE_LEVEL,
  55
  56     //-------------------------------------------------------------------------
  57     /** Searches through the complete hierarchy of all sub-objects.
  58     */
  59     DEEP
  60
  61 };
  62
  63 //=============================================================================
  64
  65 }; }; }; };
  66
  67 #endif