offapi/com/sun/star/form/runtime/XFeatureInvalidation.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
  20
  21 module com { module sun { module star { module form { module runtime {
  22
  23
  24 /** implements a callback for a XFormOperations instance, which is called
  25     when the state of one or more FormFeatures might have changed.
  26
  27     @see XFormOperations
  28
  29     @since OOo 2.2
  30 */
  31 interface XFeatureInvalidation
  32 {
  33     /** invalidates the given FormFeatures
  34
  35         <p>Invalidation means that any user interface representation (such as toolbox buttons), or
  36         any dispatches associated with the features in question are potentially out-of-date, and
  37         need to be updated.</p>
  38
  39         @param Features
  40             The set of features whose state might have changed.
  41     */
  42     void    invalidateFeatures( [in] sequence< short > Features );
  43
  44     /** invalidates all features
  45
  46         <p>This method is used of it cannot be exactly and reliably determined
  47         which features might actually have changed their state. In this case, the callee
  48         should assume all features it is interested in must be required.</p>
  49     */
  50     void    invalidateAllFeatures();
  51 };
  52
  53
  54 }; }; }; }; };
  55
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */