offapi/com/sun/star/ucb/Rule.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_Rule_idl__
  20 #define __com_sun_star_ucb_Rule_idl__
  21
  22 #include <com/sun/star/ucb/RuleTerm.idl>
  23
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** describes a rule that can be applies to a number of objects.
  29
  30     <p>A rule consists of a sequence of RuleTerms describing the
  31     objects to which the rule should be applied, the RuleAction
  32     which should be used on the matching objects, and a parameter.
  33 */
  34 published struct Rule
  35 {
  36     /** the rule terms describing the objects to which the rule should be
  37         applied.
  38     */
  39     sequence<com::sun::star::ucb::RuleTerm> Terms;
  40
  41     /** Some RuleActions require a parameter.
  42
  43         <table border =1>
  44         <tr>
  45             <th>Action</th>
  46             <th>Parameter</th>
  47         </tr>
  48         <tr>
  49             <td>COPY, MOVE, LINK</td>
  50             <td>The URL to the destination folder.</td>
  51         </tr>
  52         <tr>
  53             <td>FORWARD</td>
  54             <td>The email address of the recipient</td>
  55         </tr>
  56         <tr>
  57             <td>All other actions</td>
  58             <td>n/a</td>
  59         </tr>
  60         </table>
  61     */
  62     string Parameter;
  63
  64     /** the action to perform on the matching objects.
  65
  66         <p>The value can be one of the RuleAction constants.
  67     */
  68     short Action;
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */