Branch data     Line data    Source code

       1                 :            : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2                 :            : /*************************************************************************
       3                 :            :  *
       4                 :            :  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       5                 :            :  *
       6                 :            :  * Copyright 2000, 2010 Oracle and/or its affiliates.
       7                 :            :  *
       8                 :            :  * OpenOffice.org - a multi-platform office productivity suite
       9                 :            :  *
      10                 :            :  * This file is part of OpenOffice.org.
      11                 :            :  *
      12                 :            :  * OpenOffice.org is free software: you can redistribute it and/or modify
      13                 :            :  * it under the terms of the GNU Lesser General Public License version 3
      14                 :            :  * only, as published by the Free Software Foundation.
      15                 :            :  *
      16                 :            :  * OpenOffice.org is distributed in the hope that it will be useful,
      17                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      18                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      19                 :            :  * GNU Lesser General Public License version 3 for more details
      20                 :            :  * (a copy is included in the LICENSE file that accompanied this code).
      21                 :            :  *
      22                 :            :  * You should have received a copy of the GNU Lesser General Public License
      23                 :            :  * version 3 along with OpenOffice.org.  If not, see
      24                 :            :  * <http://www.openoffice.org/license.html>
      25                 :            :  * for a copy of the LGPLv3 License.
      26                 :            :  *
      27                 :            :  ************************************************************************/
      28                 :            : 
      29                 :            : #ifndef _SVX_ACCESSIBILITY_IACCESSIBLE_VIEW_FORWARDER_LISTENER_HXX
      30                 :            : #define _SVX_ACCESSIBILITY_IACCESSIBLE_VIEW_FORWARDER_LISTENER_HXX
      31                 :            : 
      32                 :            : #include <sal/types.h>
      33                 :            : #include <tools/gen.hxx>
      34                 :            : 
      35                 :            : 
      36                 :            : namespace accessibility {
      37                 :            : 
      38                 :            : class IAccessibleViewForwarder;
      39                 :            : 
      40                 :            : /** <p>The purpose of this interface is to notify a user of an
      41                 :            :     IAccessibleViewForwarder when that view forwarder changes its
      42                 :            :     properties.  Such a change may be one of the following:
      43                 :            :     <ul>
      44                 :            :     <li>Change of the coordinate transformation.</li>
      45                 :            :     <li>Change of the visible area (which in turn results in a change of the
      46                 :            :     coordinate transformation.</li>
      47                 :            :     <li>Change of the validity state of the view forwarder.</li>
      48                 :            : */
      49                 :         34 : class IAccessibleViewForwarderListener
      50                 :            : {
      51                 :            : public:
      52                 :            :     /** Enumeration of the different change types.
      53                 :            :     */
      54                 :            :     enum ChangeType {TRANSFORMATION, VISIBLE_AREA, STATE};
      55                 :            : 
      56                 :            :     /** This method is called to indicate a change of the specified view
      57                 :            :         forwarder.
      58                 :            :         @param aChangeType
      59                 :            :             The type of the change.  TRANSFORMATION indicates a change of
      60                 :            :             the coordinate transformation with a constant visible area.  If
      61                 :            :             the visible area changes, just use VISIBLE_AREA.  This changes
      62                 :            :             the transformation implicitly.  The value STATE indicates a
      63                 :            :             change of the validity state.  Check the IsValid method of the
      64                 :            :             view forwarder before doing further calls.
      65                 :            :         @param pViewForwarder
      66                 :            :             The modified view forwarder.  It is specified just in case that
      67                 :            :             there is more than one view forwarder in use at the same time.
      68                 :            :     */
      69                 :            :     virtual void ViewForwarderChanged (ChangeType aChangeType,
      70                 :            :         const IAccessibleViewForwarder* pViewForwarder) = 0;
      71                 :            : 
      72                 :            : protected:
      73                 :         34 :     ~IAccessibleViewForwarderListener() {}
      74                 :            : };
      75                 :            : 
      76                 :            : } // end of namespace accessibility
      77                 :            : 
      78                 :            : #endif
      79                 :            : 
      80                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */