include/test/a11y/eventposter.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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
  10 #pragma once
  11
  12 #include <test/testdllapi.hxx>
  13
  14 #include <com/sun/star/accessibility/XAccessible.hpp>
  15 #include <com/sun/star/accessibility/XAccessibleContext.hpp>
  16 #include <com/sun/star/uno/Reference.hxx>
  17
  18 #include <LibreOfficeKit/LibreOfficeKitEnums.h>
  19 #include <rtl/ustring.hxx>
  20 #include <vcl/window.hxx>
  21
  22 namespace test
  23 {
  24 /**
  25  * @brief Base helper class to send events to a window.
  26  *
  27  * Implementations of this helper will usually just wrap an implementation of post*Event*() calls.
  28  * This class is mostly useful to encapsulate the calls when getting the target window is not
  29  * trivial or is only relevant to sending events, and to have a generic event poster interface.
  30  *
  31  * Additionally, this class provides simplified helpers to send event pairs, like key down/up, or
  32  * text+commit, to make it easier on the common case for callers.
  33  */
  34 class OOO_DLLPUBLIC_TEST EventPosterHelperBase
  35 {
  36 public:
  37     virtual ~EventPosterHelperBase(){};
  38
  39     /** @see SfxLokHelper::postKeyEventAsync */
  40     virtual void postKeyEventAsync(int nType, int nCharCode, int nKeyCode) const = 0;
  41
  42     /** Posts a full key down/up cycle */
  43     void postKeyEventAsync(int nCharCode, int nKeyCode) const
  44     {
  45         postKeyEventAsync(LOK_KEYEVENT_KEYINPUT, nCharCode, nKeyCode);
  46         postKeyEventAsync(LOK_KEYEVENT_KEYUP, nCharCode, nKeyCode);
  47     }
  48
  49     /** @see SfxLokHelper::postExtTextEventAsync */
  50     virtual void postExtTextEventAsync(int nType, const OUString& rText) const = 0;
  51
  52     /** Posts a full text input + commit sequence */
  53     void postExtTextEventAsync(const OUString& rText) const
  54     {
  55         postExtTextEventAsync(LOK_EXT_TEXTINPUT, rText);
  56         postExtTextEventAsync(LOK_EXT_TEXTINPUT_END, rText);
  57     }
  58 };
  59
  60 /**
  61  * @brief Helper to send events to a window.
  62  *
  63  * This helper basically just wraps SfxLokHelper::post*EventAsync() calls to hold the target window
  64  * reference in the class.
  65  */
  66 class OOO_DLLPUBLIC_TEST EventPosterHelper : public EventPosterHelperBase
  67 {
  68 protected:
  69     VclPtr<vcl::Window> mxWindow;
  70
  71 public:
  72     EventPosterHelper(void)
  73         : mxWindow(nullptr)
  74     {
  75     }
  76     EventPosterHelper(VclPtr<vcl::Window> xWindow)
  77         : mxWindow(xWindow)
  78     {
  79     }
  80     EventPosterHelper(vcl::Window* pWindow)
  81         : mxWindow(pWindow)
  82     {
  83     }
  84
  85     vcl::Window* getWindow() const { return mxWindow; }
  86
  87     void setWindow(VclPtr<vcl::Window> xWindow) { mxWindow = xWindow; }
  88     void setWindow(vcl::Window* pWindow) { mxWindow = pWindow; }
  89
  90     explicit operator bool() const { return mxWindow && !mxWindow->isDisposed(); }
  91     bool operator!() const { return !bool(*this); }
  92
  93     using EventPosterHelperBase::postKeyEventAsync;
  94     using EventPosterHelperBase::postExtTextEventAsync;
  95
  96     /** @see SfxLokHelper::postKeyEventAsync */
  97     virtual void postKeyEventAsync(int nType, int nCharCode, int nKeyCode) const override;
  98     /** @see SfxLokHelper::postExtTextEventAsync */
  99     virtual void postExtTextEventAsync(int nType, const OUString& rText) const override;
 100 };
 101
 102 /**
 103  * @brief Accessibility-specialized helper to send events to a window.
 104  *
 105  * This augments @c test::EventPosterHelper to simplify usage in accessibility tests.
 106  */
 107 class OOO_DLLPUBLIC_TEST AccessibleEventPosterHelper : public EventPosterHelper
 108 {
 109 public:
 110     AccessibleEventPosterHelper(void)
 111         : EventPosterHelper()
 112     {
 113     }
 114     AccessibleEventPosterHelper(const css::uno::Reference<css::accessibility::XAccessible> xAcc)
 115     {
 116         setWindow(xAcc);
 117     }
 118
 119     /**
 120      * @brief Sets the window on which post events based on an accessible object inside it.
 121      * @param xAcc An accessible object inside a toplevel.
 122      *
 123      * This method tries and find the top level window containing @p xAcc to use it to post events.
 124      *
 125      * This currently relies on a toplevel accessible being a @c VCLXWindow, and requires that
 126      * window's output device to be set (@see VCLXWindow::GetWindow()).
 127      */
 128     void setWindow(css::uno::Reference<css::accessibility::XAccessible> xAcc);
 129 };
 130 }
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */