offapi/com/sun/star/ucb/XPropertyMatcher.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_XPropertyMatcher_idl__
  20 #define __com_sun_star_ucb_XPropertyMatcher_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/XCommandProcessor.idl>
  24 #include <com/sun/star/ucb/XCommandEnvironment.idl>
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** Checks whether a set of properties matches a set of search criteria.
  30
  31     @see  XPropertyMatcherFactory.
  32 */
  33 published interface XPropertyMatcher : com::sun::star::uno::XInterface
  34 {
  35     /** Checks whether a set of properties matches the given search criteria.
  36
  37         @param Properties
  38         A Command Processor through which the set of properties is accessible.
  39
  40         @param Environment
  41         The environment to use when accessing the property  set via the given
  42          Command Processor.  It may be null.
  43
  44         @returns
  45         `TRUE` if the properties match, `FALSE` otherwise.
  46     */
  47     boolean matches([in] com::sun::star::ucb::XCommandProcessor Properties,
  48                     [in] com::sun::star::ucb::XCommandEnvironment Environment);
  49 };
  50
  51
  52 }; }; }; };
  53
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */