offapi/com/sun/star/ucb/SearchInfo.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_SearchInfo_idl__
  20 #define __com_sun_star_ucb_SearchInfo_idl__
  21
  22 #include <com/sun/star/ucb/SearchCriterium.idl>
  23 #include <com/sun/star/ucb/SearchRecursion.idl>
  24
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** information needed to (recursively) search an object.
  30 */
  31 published struct SearchInfo
  32 {
  33     /** the search criteria.
  34     */
  35     sequence<com::sun::star::ucb::SearchCriterium> Criteria;
  36
  37     /** the mode of recursion to use.
  38     */
  39     com::sun::star::ucb::SearchRecursion Recursion;
  40
  41     /** whether to include the object itself in the search or only (some of)
  42         its sub-objects.
  43     */
  44     boolean IncludeBase;
  45
  46     /** whether to respect the "view restrictions" specified for the folders
  47         hierarchically contained within an object (e.g., only searches through
  48         subscribed folders).
  49     */
  50     boolean RespectFolderViewRestrictions;
  51
  52     /** whether to respect the "view restrictions" specified for the documents
  53         hierarchically contained within an object (e.g., only searches through
  54         marked documents).
  55     */
  56     boolean RespectDocViewRestrictions;
  57
  58     /** whether to follow indirections (link objects) and search through their
  59         respective targets also.
  60     */
  61     boolean FollowIndirections;
  62
  63 };
  64
  65
  66 }; }; }; };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */