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