256 lines
8.8 KiB
C++
256 lines
8.8 KiB
C++
/* -*- 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 <com/sun/star/awt/XWindow2.hpp>
|
|
|
|
#include <canvas/canvastools.hxx>
|
|
#include <base/graphicdevicebase.hxx>
|
|
|
|
namespace com::sun::star::awt { class XTopWindow; }
|
|
|
|
|
|
/* Definition of BufferedGraphicDeviceBase class */
|
|
|
|
namespace canvas
|
|
{
|
|
/** Helper template base class for XGraphicDevice implementations
|
|
on windows.
|
|
|
|
Use this base class if your target device is a
|
|
window. Additionally to GraphicDeviceBase, this template
|
|
provides an implementation of the awt::XWindowListener
|
|
interface, to receive notifications about state changes of the
|
|
associated window.
|
|
|
|
@tpl Base
|
|
Base class to use, most probably one of the
|
|
WeakComponentImplHelperN templates with the appropriate
|
|
interfaces. At least XGraphicDevice should be among them (why else
|
|
would you use this template, then?). Base class must have an
|
|
Base( const Mutex& ) constructor (like the
|
|
WeakComponentImplHelperN templates have). As the very least,
|
|
the base class must be derived from uno::XInterface, as some
|
|
error reporting mechanisms rely on that.
|
|
|
|
@tpl DeviceHelper
|
|
Device helper implementation for the backend in question. This
|
|
object will be held as a member of this template class, and
|
|
basically gets forwarded all XGraphicDevice API calls that
|
|
could not be handled generically.
|
|
|
|
@tpl Mutex
|
|
Lock strategy to use. Defaults to using the
|
|
BaseMutex-provided lock. Every time one of the methods is
|
|
entered, an object of type Mutex is created with m_aMutex as
|
|
the sole parameter, and destroyed again when the method scope
|
|
is left.
|
|
|
|
@tpl UnambiguousBase
|
|
Optional unambiguous base class for XInterface of Base. It's
|
|
sometimes necessary to specify this parameter, e.g. if Base
|
|
derives from multiple UNO interface (were each provides its
|
|
own version of XInterface, making the conversion ambiguous)
|
|
*/
|
|
template< class Base,
|
|
class DeviceHelper,
|
|
class Mutex=::osl::MutexGuard,
|
|
class UnambiguousBase = css::uno::XInterface > class BufferedGraphicDeviceBase :
|
|
public GraphicDeviceBase< Base, DeviceHelper, Mutex, UnambiguousBase >
|
|
{
|
|
public:
|
|
typedef GraphicDeviceBase< Base, DeviceHelper, Mutex, UnambiguousBase > BaseType;
|
|
typedef Mutex MutexType;
|
|
|
|
BufferedGraphicDeviceBase() :
|
|
mbIsVisible( false ),
|
|
mbIsTopLevel( false )
|
|
{
|
|
BaseType::maPropHelper.addProperties(
|
|
PropertySetHelper::MakeMap("Window",
|
|
[this] () { return this->getXWindow(); }));
|
|
}
|
|
|
|
// XGraphicDevice
|
|
virtual css::uno::Reference< css::rendering::XBufferController > SAL_CALL getBufferController( ) override
|
|
{
|
|
return this;
|
|
}
|
|
|
|
// XBufferController
|
|
virtual ::sal_Int32 SAL_CALL createBuffers( ::sal_Int32 nBuffers ) override
|
|
{
|
|
tools::verifyRange( nBuffers, sal_Int32(1) );
|
|
|
|
return 1;
|
|
}
|
|
|
|
virtual void SAL_CALL destroyBuffers( ) override
|
|
{
|
|
}
|
|
|
|
virtual sal_Bool SAL_CALL showBuffer( sal_Bool bUpdateAll ) override
|
|
{
|
|
MutexType aGuard( BaseType::m_aMutex );
|
|
|
|
return BaseType::maDeviceHelper.showBuffer( mbIsVisible, bUpdateAll );
|
|
}
|
|
|
|
virtual sal_Bool SAL_CALL switchBuffer( sal_Bool bUpdateAll ) override
|
|
{
|
|
MutexType aGuard( BaseType::m_aMutex );
|
|
|
|
return BaseType::maDeviceHelper.switchBuffer( mbIsVisible, bUpdateAll );
|
|
}
|
|
|
|
|
|
/** Set corresponding canvas window
|
|
|
|
Use this method to set the window this canvas displays
|
|
on. Comes in handy when the canvas needs to adapt size or
|
|
output position to the changing window.
|
|
|
|
Whenever the bounds of the window change, <code>void
|
|
notifySizeUpdate( const awt::Rectangle& rBounds )</code>
|
|
is called, with rBounds the window bound rect relative to
|
|
the frame window.
|
|
*/
|
|
void setWindow( const css::uno::Reference< css::awt::XWindow2 >& rWindow )
|
|
{
|
|
if( mxWindow.is() )
|
|
mxWindow->removeWindowListener( this );
|
|
|
|
mxWindow = rWindow;
|
|
|
|
if( mxWindow.is() )
|
|
{
|
|
mbIsVisible = mxWindow->isVisible();
|
|
mbIsTopLevel =
|
|
css::uno::Reference< css::awt::XTopWindow >(
|
|
mxWindow,
|
|
css::uno::UNO_QUERY ).is();
|
|
|
|
maBounds = transformBounds( mxWindow->getPosSize() );
|
|
mxWindow->addWindowListener( this );
|
|
}
|
|
}
|
|
|
|
css::uno::Any getXWindow() const
|
|
{
|
|
return css::uno::Any(mxWindow);
|
|
}
|
|
|
|
virtual void disposeThis() override
|
|
{
|
|
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
|
|
|
|
if( mxWindow.is() )
|
|
{
|
|
mxWindow->removeWindowListener(this);
|
|
mxWindow.clear();
|
|
}
|
|
|
|
// pass on to base class
|
|
BaseType::disposeThis();
|
|
}
|
|
|
|
css::awt::Rectangle transformBounds( const css::awt::Rectangle& rBounds )
|
|
{
|
|
// notifySizeUpdate's bounds are relative to the toplevel
|
|
// window
|
|
if( !mbIsTopLevel )
|
|
return tools::getAbsoluteWindowRect(
|
|
rBounds,
|
|
mxWindow );
|
|
else
|
|
return css::awt::Rectangle( 0,0,rBounds.Width,rBounds.Height );
|
|
}
|
|
|
|
void boundsChanged( const css::awt::WindowEvent& e )
|
|
{
|
|
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
|
|
|
|
const css::awt::Rectangle& rNewBounds(
|
|
transformBounds( css::awt::Rectangle( e.X,
|
|
e.Y,
|
|
e.Width,
|
|
e.Height )));
|
|
|
|
if( rNewBounds.X != maBounds.X ||
|
|
rNewBounds.Y != maBounds.Y ||
|
|
rNewBounds.Width != maBounds.Width ||
|
|
rNewBounds.Height != maBounds.Height )
|
|
{
|
|
maBounds = rNewBounds;
|
|
BaseType::maDeviceHelper.notifySizeUpdate( maBounds );
|
|
}
|
|
}
|
|
|
|
// XWindowListener
|
|
virtual void disposeEventSource( const css::lang::EventObject& Source ) override
|
|
{
|
|
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
|
|
|
|
if( Source.Source == mxWindow )
|
|
mxWindow.clear();
|
|
|
|
BaseType::disposeEventSource(Source);
|
|
}
|
|
|
|
virtual void SAL_CALL windowResized( const css::awt::WindowEvent& e ) override
|
|
{
|
|
boundsChanged( e );
|
|
}
|
|
|
|
virtual void SAL_CALL windowMoved( const css::awt::WindowEvent& e ) override
|
|
{
|
|
boundsChanged( e );
|
|
}
|
|
|
|
virtual void SAL_CALL windowShown( const css::lang::EventObject& ) override
|
|
{
|
|
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
|
|
|
|
mbIsVisible = true;
|
|
}
|
|
|
|
virtual void SAL_CALL windowHidden( const css::lang::EventObject& ) override
|
|
{
|
|
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
|
|
|
|
mbIsVisible = false;
|
|
}
|
|
|
|
protected:
|
|
css::uno::Reference< css::awt::XWindow2 > mxWindow;
|
|
|
|
/// Current bounds of the owning Window
|
|
css::awt::Rectangle maBounds;
|
|
|
|
/// True, if the window this canvas is contained in, is visible
|
|
bool mbIsVisible;
|
|
|
|
private:
|
|
/// True, if the window this canvas is contained in, is a toplevel window
|
|
bool mbIsTopLevel;
|
|
};
|
|
}
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|