mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
libreoffice/include/toolkit/awt/vclxwindow.hxx
Michael Weghorn 7503bb286f [API CHANGE] a11y: Drop UNO service to create a11y contexts 
Drop the com.sun.star.accessibility.GetStandardAccessibleFactoryService
UNO service that was used to create instances of
the a11y classes for (mainly vcl) widgets.

The service was needed to break a dependency cycle.
However, with

    Change-Id: Ib46c87446dc9121d3b8e735e0e5a40594da73cc5
    Author: Michael Weghorn <m.weghorn@posteo.de>
    Date:   Tue Dec 17 12:04:04 2024 +0100

        a11y: Merge accessibility module into vcl

and all the preparatory commits in place, there
is no more dependency cycle, as the a11y classes
for vcl widgets no longer depend on any modules
"above" vcl.

Therefore, drop the UNO service and the abstract
vcl::IAccessibleFactory class and other related
classes.

Make all methods in the AccessibleFactory class
(that was previously subclassing the abstract
IAccessibleFactory) static helper methods,
and call them directly.

The UNO service dropped in this commit was
introduced in

    commit 1af510e95147374e5289ae1c12f1f280931919f4
    Date:   Wed Feb 21 11:30:47 2024 +0200

        Create an UNO service to do the symbol lookup in toolkit::AccessibilityClient

and its documentation was already clearly stating
that it's only meant for LibreOffice internal use:

> /**
>   The toolkit module uses this to get a pointer to the AccessibleFactory from the acc module.
>   Because we have a dependency in our modules that goes the "wrong" way.
>
>   @since LibreOffice 24.8
>
>   @internal
>
>   ATTENTION: This is marked <em>internal</em> and does not
>   have the <em>published</em> flag, which means it is subject to
>   change without notice and should not be used outside the LibreOffice core.
> */

Change-Id: Ib97396a4bad486d9530361dd851ad3ee0f9681b8
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/178689
Reviewed-by: Michael Weghorn <m.weghorn@posteo.de>
Tested-by: Jenkins
2024-12-17 22:57:26 +01:00

226 lines
11 KiB
C++
Raw Permalink Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include <toolkit/dllapi.h>
#include <toolkit/awt/vclxdevice.hxx>
#include <vcl/vclptr.hxx>
#include <com/sun/star/awt/XWindow2.hpp>
#include <com/sun/star/awt/XVclWindowPeer.hpp>
#include <com/sun/star/awt/XLayoutConstrains.hpp>
#include <com/sun/star/awt/XView.hpp>
#include <com/sun/star/beans/XPropertySetInfo.hpp>
#include <com/sun/star/accessibility/XAccessible.hpp>
#include <com/sun/star/awt/XDockableWindow.hpp>
#include <com/sun/star/awt/XStyleSettingsSupplier.hpp>
#include <cppuhelper/implbase.hxx>
#include <tools/gen.hxx>
#include <tools/link.hxx>
#include <memory>
#include <vector>
#include <functional>
template <class ListenerT> class ListenerMultiplexerBase;
namespace com::sun::star::accessibility { class XAccessibleContext; }
namespace com::sun::star::awt { class XTopWindowListener; }
namespace com::sun::star::awt { class XVclContainerListener; }
namespace vcl { class Window; }
class VclWindowEvent;
class UnoPropertyArrayHelper;
class VCLXWindowImpl;
typedef cppu::ImplInheritanceHelper< VCLXDevice,
css::awt::XWindow2,
css::awt::XVclWindowPeer,
css::awt::XLayoutConstrains,
css::awt::XView,
css::awt::XDockableWindow,
css::accessibility::XAccessible,
css::lang::XEventListener,
css::beans::XPropertySetInfo,
css::awt::XStyleSettingsSupplier
> VCLXWindow_Base;
class TOOLKIT_DLLPUBLIC VCLXWindow : public VCLXWindow_Base
{
private:
std::unique_ptr<VCLXWindowImpl> mpImpl;
UnoPropertyArrayHelper *GetPropHelper();
protected:
Size ImplCalcWindowSize( const Size& rOutSz ) const;
DECL_DLLPRIVATE_LINK(WindowEventListener, VclWindowEvent&, void );
virtual void ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent );
virtual css::uno::Reference< css::accessibility::XAccessibleContext >
CreateAccessibleContext();
void SetSynthesizingVCLEvent( bool b );
bool IsSynthesizingVCLEvent() const;
void SetSystemParent_Impl( const css::uno::Any& rHandle );
// helper ...
static void PushPropertyIds( std::vector< sal_uInt16 > &aIds, int nFirstId, ...);
// for use in controls/
static void ImplGetPropertyIds( std::vector< sal_uInt16 > &aIds,
bool bWithDefaults = false );
virtual void GetPropertyIds( std::vector< sal_uInt16 > &aIds );
ListenerMultiplexerBase<css::awt::XVclContainerListener>& GetContainerListeners();
ListenerMultiplexerBase<css::awt::XTopWindowListener>& GetTopWindowListeners();
public:
typedef ::std::function<void ()> Callback;
protected:
/** executes the given callback asynchronously
At the moment the callback is called, the Solar Mutex is not locked. In particular, this implies that
you cannot rely on |this| not being disposed. However, you *can* rely on |this| being still alive (i.e.
having a ref count > 0).
As a consequence, this can be used for doing listener notifications, using event multiplexers. Those multiplexers
care for the disposed state themself, and are alive as long as |this| is alive.
*/
void ImplExecuteAsyncWithoutSolarLock(
const Callback& i_callback
);
public:
VCLXWindow( bool bWithDefaultProps = false );
virtual ~VCLXWindow() override;
virtual void SetWindow( const VclPtr< vcl::Window > &pWindow );
template< class derived_type > derived_type* GetAs() const {
return static_cast< derived_type * >( GetWindow() ); }
template< class derived_type > derived_type* GetAsDynamic() const {
return dynamic_cast< derived_type * >( GetWindow() ); }
vcl::Window* GetWindow() const
{
auto p = GetOutputDevice().get();
return p ? p->GetOwnerWindow() : nullptr;
}
void suspendVclEventListening( );
void resumeVclEventListening( );
void notifyWindowRemoved( vcl::Window const & _rWindow );
bool IsDisposed() const;
// css::lang::XEventListener
virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
// css::lang::XComponent
void SAL_CALL dispose( ) override;
void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& rxListener ) override;
void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& rxListener ) override;
// css::awt::XWindow
void SAL_CALL setPosSize( sal_Int32 X, sal_Int32 Y, sal_Int32 Width, sal_Int32 Height, sal_Int16 Flags ) override;
css::awt::Rectangle SAL_CALL getPosSize( ) override;
void SAL_CALL setVisible( sal_Bool Visible ) override;
void SAL_CALL setEnable( sal_Bool Enable ) override;
void SAL_CALL setFocus( ) override;
void SAL_CALL addWindowListener( const css::uno::Reference< css::awt::XWindowListener >& rrxListener ) override;
void SAL_CALL removeWindowListener( const css::uno::Reference< css::awt::XWindowListener >& rrxListener ) override;
void SAL_CALL addFocusListener( const css::uno::Reference< css::awt::XFocusListener >& rrxListener ) override;
void SAL_CALL removeFocusListener( const css::uno::Reference< css::awt::XFocusListener >& rrxListener ) override;
void SAL_CALL addKeyListener( const css::uno::Reference< css::awt::XKeyListener >& rrxListener ) override;
void SAL_CALL removeKeyListener( const css::uno::Reference< css::awt::XKeyListener >& rrxListener ) override;
void SAL_CALL addMouseListener( const css::uno::Reference< css::awt::XMouseListener >& rrxListener ) override;
void SAL_CALL removeMouseListener( const css::uno::Reference< css::awt::XMouseListener >& rrxListener ) override;
void SAL_CALL addMouseMotionListener( const css::uno::Reference< css::awt::XMouseMotionListener >& rrxListener ) override;
void SAL_CALL removeMouseMotionListener( const css::uno::Reference< css::awt::XMouseMotionListener >& rrxListener ) override;
void SAL_CALL addPaintListener( const css::uno::Reference< css::awt::XPaintListener >& rrxListener ) override;
void SAL_CALL removePaintListener( const css::uno::Reference< css::awt::XPaintListener >& rrxListener ) override;
// css::awt::XWindowPeer
css::uno::Reference< css::awt::XToolkit > SAL_CALL getToolkit( ) override;
void SAL_CALL setPointer( const css::uno::Reference< css::awt::XPointer >& Pointer ) override;
void SAL_CALL setBackground( sal_Int32 Color ) override;
void SAL_CALL invalidate( sal_Int16 Flags ) override;
void SAL_CALL invalidateRect( const css::awt::Rectangle& Rect, sal_Int16 Flags ) override;
// css::awt::XVclWindowPeer
sal_Bool SAL_CALL isChild( const css::uno::Reference< css::awt::XWindowPeer >& Peer ) override;
void SAL_CALL setDesignMode( sal_Bool bOn ) override;
sal_Bool SAL_CALL isDesignMode( ) override;
void SAL_CALL enableClipSiblings( sal_Bool bClip ) override;
void SAL_CALL setForeground( sal_Int32 Color ) override;
void SAL_CALL setControlFont( const css::awt::FontDescriptor& aFont ) override;
void SAL_CALL getStyles( sal_Int16 nType, css::awt::FontDescriptor& Font, sal_Int32& ForegroundColor, sal_Int32& BackgroundColor ) override;
void SAL_CALL setProperty( const OUString& PropertyName, const css::uno::Any& Value ) override;
css::uno::Any SAL_CALL getProperty( const OUString& PropertyName ) override;
// css::awt::XLayoutConstrains
css::awt::Size SAL_CALL getMinimumSize( ) override;
css::awt::Size SAL_CALL getPreferredSize( ) override;
css::awt::Size SAL_CALL calcAdjustedSize( const css::awt::Size& aNewSize ) override;
// css::awt::XView
sal_Bool SAL_CALL setGraphics( const css::uno::Reference< css::awt::XGraphics >& aDevice ) override;
css::uno::Reference< css::awt::XGraphics > SAL_CALL getGraphics( ) override;
css::awt::Size SAL_CALL getSize( ) override;
void SAL_CALL draw( sal_Int32 nX, sal_Int32 nY ) override;
void SAL_CALL setZoom( float fZoomX, float fZoomY ) override;
// css::accessibility::XAccessible
css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext( ) override;
// css::awt::XDockableWindow
void SAL_CALL addDockableWindowListener( const css::uno::Reference< css::awt::XDockableWindowListener >& xListener ) override;
void SAL_CALL removeDockableWindowListener( const css::uno::Reference< css::awt::XDockableWindowListener >& xListener ) override;
void SAL_CALL enableDocking( sal_Bool bEnable ) override;
sal_Bool SAL_CALL isFloating( ) override;
void SAL_CALL setFloatingMode( sal_Bool bFloating ) override;
void SAL_CALL lock( ) override;
void SAL_CALL unlock( ) override;
sal_Bool SAL_CALL isLocked( ) override;
void SAL_CALL startPopupMode( const css::awt::Rectangle& WindowRect ) override;
sal_Bool SAL_CALL isInPopupMode( ) override;
// css::awt::XWindow2
void SAL_CALL setOutputSize( const css::awt::Size& aSize ) override;
css::awt::Size SAL_CALL getOutputSize( ) override;
sal_Bool SAL_CALL isVisible( ) override;
sal_Bool SAL_CALL isActive( ) override;
sal_Bool SAL_CALL isEnabled( ) override;
sal_Bool SAL_CALL hasFocus( ) override;
// css::beans::XPropertySetInfo
css::uno::Sequence< css::beans::Property > SAL_CALL getProperties( ) override;
css::beans::Property SAL_CALL getPropertyByName( const OUString& aName ) override;
sal_Bool SAL_CALL hasPropertyByName( const OUString& Name ) override;
// XStyleSettingsSupplier
virtual css::uno::Reference< css::awt::XStyleSettings > SAL_CALL getStyleSettings() override;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink