sd/source/ui/inc/AccessibleViewForwarder.hxx

   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_SD_SOURCE_UI_INC_ACCESSIBLEVIEWFORWARDER_HXX
  21 #define INCLUDED_SD_SOURCE_UI_INC_ACCESSIBLEVIEWFORWARDER_HXX
  22
  23 #include <svx/IAccessibleViewForwarder.hxx>
  24
  25 class SdrPaintView;
  26 class OutputDevice;
  27
  28 namespace accessibility {
  29
  30 /** <p>This class provides the means to transform between internal coordinates
  31     and screen coordinates without giving direct access to the underlying
  32     view.  It represents a certain window.  A call to
  33     <method>GetVisArea</method> returns the corresponding visible
  34     rectangle.</p>
  35
  36     @attention
  37         Note, that modifications of the underlying view that lead to
  38         different transformations between internal and screen coordinates or
  39         change the validity of the forwarder have to be signaled separately.
  40 */
  41 class AccessibleViewForwarder
  42     :   public IAccessibleViewForwarder
  43 {
  44 public:
  45     //=====  internal  ========================================================
  46
  47     AccessibleViewForwarder (SdrPaintView* pView, OutputDevice& rDevice);
  48
  49     virtual ~AccessibleViewForwarder();
  50
  51     //=====  IAccessibleViewforwarder  ========================================
  52
  53     /** This method informs you about the state of the forwarder.  Do not
  54         use it when the returned value is <false/>.
  55
  56         @return
  57             Return <true/> if the view forwarder is valid and <false/> else.
  58      */
  59     virtual bool IsValid() const SAL_OVERRIDE;
  60
  61     /** Returns the area of the underlying document that is visible in the
  62     * corresponding window.
  63
  64         @return
  65             The rectangle of the visible part of the document.
  66      */
  67     virtual Rectangle GetVisibleArea() const SAL_OVERRIDE;
  68
  69     /** Transform the specified point from internal coordinates to an
  70         absolute screen position.
  71
  72         @param rPoint
  73             Point in internal coordinates.
  74
  75         @return
  76             The same point but in screen coordinates relative to the upper
  77             left corner of the (current) screen.
  78      */
  79     virtual Point LogicToPixel (const Point& rPoint) const SAL_OVERRIDE;
  80
  81     /** Transform the specified size from internal coordinates to a screen
  82     * position.
  83
  84         @param rSize
  85             Size in internal coordinates.
  86
  87         @return
  88             The same size but in screen coordinates.
  89      */
  90     virtual Size LogicToPixel (const Size& rSize) const SAL_OVERRIDE;
  91
  92     /** Transform the specified point from absolute screen coordinates to
  93         internal coordinates.
  94
  95         @param rPoint
  96             Point in screen coordinates relative to the upper left corner of
  97             the (current) screen.
  98
  99         @return
 100             The same point but in internal coordinates.
 101      */
 102     virtual Point PixelToLogic (const Point& rPoint) const SAL_OVERRIDE;
 103
 104     /** Transform the specified Size from screen coordinates to internal
 105         coordinates.
 106
 107         @param rSize
 108             Size in screen coordinates.
 109
 110         @return
 111             The same size but in internal coordinates.
 112      */
 113     virtual Size PixelToLogic (const Size& rSize) const SAL_OVERRIDE;
 114
 115 protected:
 116     SdrPaintView* mpView;
 117     sal_uInt16 mnWindowId;
 118     OutputDevice& mrDevice;
 119
 120 private:
 121     AccessibleViewForwarder (AccessibleViewForwarder&) SAL_DELETED_FUNCTION;
 122     AccessibleViewForwarder& operator= (AccessibleViewForwarder&) SAL_DELETED_FUNCTION;
 123 };
 124
 125 } // end of namespace accessibility
 126
 127 #endif
 128
 129 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */