Line data    Source code

       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 INCLUDED_SVX_IACCESSIBLEVIEWFORWARDERLISTENER_HXX
      21             : #define INCLUDED_SVX_IACCESSIBLEVIEWFORWARDERLISTENER_HXX
      22             : 
      23             : #include <sal/types.h>
      24             : 
      25             : 
      26             : namespace accessibility {
      27             : 
      28             : class IAccessibleViewForwarder;
      29             : 
      30             : /** <p>The purpose of this interface is to notify a user of an
      31             :     IAccessibleViewForwarder when that view forwarder changes its
      32             :     properties.  Such a change may be one of the following:
      33             :     <ul>
      34             :     <li>Change of the coordinate transformation.</li>
      35             :     <li>Change of the visible area (which in turn results in a change of the
      36             :     coordinate transformation.</li>
      37             :     <li>Change of the validity state of the view forwarder.</li>
      38             : */
      39          40 : class IAccessibleViewForwarderListener
      40             : {
      41             : public:
      42             :     /** Enumeration of the different change types.
      43             :     */
      44             :     enum ChangeType {TRANSFORMATION, VISIBLE_AREA, STATE};
      45             : 
      46             :     /** This method is called to indicate a change of the specified view
      47             :         forwarder.
      48             :         @param aChangeType
      49             :             The type of the change.  TRANSFORMATION indicates a change of
      50             :             the coordinate transformation with a constant visible area.  If
      51             :             the visible area changes, just use VISIBLE_AREA.  This changes
      52             :             the transformation implicitly.  The value STATE indicates a
      53             :             change of the validity state.  Check the IsValid method of the
      54             :             view forwarder before doing further calls.
      55             :         @param pViewForwarder
      56             :             The modified view forwarder.  It is specified just in case that
      57             :             there is more than one view forwarder in use at the same time.
      58             :     */
      59             :     virtual void ViewForwarderChanged (ChangeType aChangeType,
      60             :         const IAccessibleViewForwarder* pViewForwarder) = 0;
      61             : 
      62             : protected:
      63          40 :     ~IAccessibleViewForwarderListener() {}
      64             : };
      65             : 
      66             : } // end of namespace accessibility
      67             : 
      68             : #endif
      69             : 
      70             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */