offapi/com/sun/star/ucb/XAnyCompare.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_XAnyCompare_idl__
  20 #define __com_sun_star_ucb_XAnyCompare_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27 /** compares two `any`s.
  28 */
  29
  30 published interface XAnyCompare: com::sun::star::uno::XInterface
  31 {
  32     /** allows comparison of two `any`s.
  33
  34         @param Any1
  35         is the first compare value
  36
  37         @param Any2
  38         is the second compare value
  39
  40         @returns
  41         <ul>
  42         <li>
  43         <code>-1</code>, if the first any is less than the second ( Any1 &lt; Any2 )
  44         </li>
  45         <li>
  46         <code>0</code>, if the first any is equal to the second ( Any1 == Any2 )
  47         </li>
  48         <li>
  49         <code>+1</code>, if the first any is greater than the second ( Any1 &gt; Any2 )
  50         </li>
  51         </ul>
  52     */
  53
  54     short   compare( [in] any Any1, [in] any Any2 );
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */