include/svx/AccessibleShapeInfo.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_SVX_ACCESSIBLESHAPEINFO_HXX
  21 #define INCLUDED_SVX_ACCESSIBLESHAPEINFO_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <svx/svxdllapi.h>
  25
  26 namespace com::sun::star {
  27     namespace accessibility { class XAccessible; }
  28     namespace drawing { class XShape; }
  29 }
  30
  31 namespace accessibility {
  32
  33 class IAccessibleParent;
  34
  35 /** @descr
  36         This class is a container for the information specific for a single
  37         shape that is passed to the constructor of that shape.  It allows to
  38         separate the class definitions of the shapes from the information
  39         needed on construction.  Only the shapes' implementation has to be
  40         adapted to a modified AccessibleShapeInfo definition.
  41
  42         <p>Note that this class complements the
  43         AccessibleShapeTreeInfo interface which contains
  44         information that is passed to all shapes in a subtree not just to a
  45         single shape. </p>
  46 */
  47 class SVX_DLLPUBLIC AccessibleShapeInfo
  48 {
  49 public:
  50     /** The shape itself for which an accessible object is to be
  51         constructed.
  52     */
  53     css::uno::Reference<
  54         css::drawing::XShape> mxShape;
  55
  56     /** The accessible parent object of the shape.
  57     */
  58     css::uno::Reference<
  59         css::accessibility::XAccessible> mxParent;
  60
  61     /** This object that may be realized by the same implementation as that
  62         of that of <member>mxParent</member> can be used to modify
  63         parent/child relationships with the shape as initiator.
  64         Note that NULL is a valid value for this member.
  65     */
  66     IAccessibleParent* mpChildrenManager;
  67
  68     /** Copy the given values into the members described above.
  69     */
  70     AccessibleShapeInfo (
  71         css::uno::Reference<
  72             css::drawing::XShape> xShape,
  73         css::uno::Reference<
  74             css::accessibility::XAccessible> xParent,
  75         IAccessibleParent* pChildrenManager);
  76
  77     /** Copy the given values into the members described above.
  78         The accessible parent implementation object is set to NULL.
  79     */
  80     AccessibleShapeInfo (
  81         css::uno::Reference<
  82             css::drawing::XShape> xShape,
  83         css::uno::Reference<
  84             css::accessibility::XAccessible> xParent);
  85
  86     ~AccessibleShapeInfo();
  87
  88     AccessibleShapeInfo (const AccessibleShapeInfo&);
  89 private:
  90     AccessibleShapeInfo& operator= (const AccessibleShapeInfo&) = delete;
  91 };
  92
  93 } // end of namespace accessibility
  94
  95 #endif
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */