Files
libreoffice/include/canvas/base/canvasbase.hxx

476 lines
24 KiB
C++
Raw Normal View 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 .
*/
#ifndef INCLUDED_CANVAS_BASE_CANVASBASE_HXX
#define INCLUDED_CANVAS_BASE_CANVASBASE_HXX
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/rendering/XCanvas.hpp>
#include <com/sun/star/rendering/TextDirection.hpp>
#include <osl/mutex.hxx>
#include <canvas/verifyinput.hxx>
namespace canvas
{
/** Helper template to handle XCanvas method forwarding to CanvasHelper
Use this helper to handle the XCanvas part of your
implementation. In theory, we could have provided CanvasHelper
and CanvasBase as a single template, but that would duplicate
a lot of code now residing in CanvasHelper only.
This template basically interposes itself between the full
interface you implement (i.e. not restricted to XCanvas. The
problem with UNO partial interface implementation actually is,
that you cannot do it the plain way, since deriving from a
common base subclass always introduces the whole set of pure
virtuals, that your baseclass helper just overrided) and your
implementation class. You then only have to implement the
functionality <em>besides</em> XCanvas.
<pre>
Example:
typedef ::cppu::WeakComponentImplHelper < css::rendering::XSpriteCanvas,
css::lang::XInitialization,
css::lang::XServiceInfo,
css::lang::XServiceName > CanvasBase_Base;
typedef ::canvas::internal::CanvasBase< CanvasBase_Base, CanvasHelper > ExampleCanvas_Base;
class ExampleCanvas : public ExampleCanvas_Base,
public SpriteSurface,
public RepaintTarget
{
};
</pre>
@tpl Base
Base class to use, most probably the
WeakComponentImplHelper template with the appropriate
interfaces. At least XCanvas should be among them (why else
would you use this template, then?). Base class must have an
Base( const Mutex& ) constructor (like the
WeakComponentImplHelper template has). As the very least,
the base class must be derived from uno::XInterface, as some
error reporting mechanisms rely on that.
@tpl CanvasHelper
Canvas helper implementation for the backend in question. This
object will be held as a member of this template class, and
basically gets forwarded all XCanvas API calls. Furthermore,
Many spelling fixes: directories a* - g*. Attempt to clean up most but certainly not all the spelling mistakes that found home in OpenOffice through decades. We could probably blame the international nature of the code but it is somewhat shameful that this wasn't done before. (cherry picked from commit a6efc99d19d533fcf53106b6667bafba4d364370) Conflicts: accessibility/bridge/org/openoffice/java/accessibility/AccessibleTextImpl.java accessibility/bridge/org/openoffice/java/accessibility/Component.java accessibility/bridge/org/openoffice/java/accessibility/Container.java accessibility/bridge/org/openoffice/java/accessibility/DescendantManager.java accessibility/bridge/org/openoffice/java/accessibility/Dialog.java accessibility/bridge/org/openoffice/java/accessibility/Frame.java accessibility/bridge/org/openoffice/java/accessibility/List.java accessibility/bridge/org/openoffice/java/accessibility/Menu.java accessibility/bridge/org/openoffice/java/accessibility/Table.java accessibility/bridge/org/openoffice/java/accessibility/Tree.java accessibility/bridge/org/openoffice/java/accessibility/Window.java accessibility/bridge/source/java/WindowsAccessBridgeAdapter.cxx accessibility/inc/accessibility/extended/AccessibleBrowseBoxBase.hxx accessibility/inc/accessibility/extended/AccessibleGridControlBase.hxx accessibility/inc/accessibility/standard/vclxaccessiblebox.hxx accessibility/source/extended/accessibleiconchoicectrlentry.cxx accessibility/source/extended/accessiblelistboxentry.cxx accessibility/source/extended/accessibletablistbox.cxx accessibility/source/extended/accessibletablistboxtable.cxx accessibility/workben/org/openoffice/accessibility/awb/canvas/Canvas.java accessibility/workben/org/openoffice/accessibility/misc/OfficeConnection.java apple_remote/AppleRemote.m autodoc/inc/ary/cpp/c_gate.hxx autodoc/inc/ary/cpp/cp_ce.hxx autodoc/inc/ary/cpp/cp_def.hxx autodoc/inc/ary/cpp/cp_type.hxx autodoc/inc/ary/doc/d_parametrized.hxx autodoc/inc/ary/idl/i_type.hxx autodoc/source/ary/inc/cross_refs.hxx autodoc/source/ary/inc/sorted_idset.hxx autodoc/source/display/html/outfile.hxx autodoc/source/display/html/pagemake.cxx autodoc/source/display/idl/hi_env.hxx autodoc/source/parser/inc/tokens/tokproct.hxx autodoc/source/parser_i/inc/s2_luidl/tokproct.hxx autodoc/source/parser_i/inc/tokens/tkp2.hxx automation/inc/automation/commtypes.hxx automation/inc/automation/simplecm.hxx automation/source/server/recorder.cxx automation/source/server/recorder.hxx automation/source/server/statemnt.cxx automation/source/simplecm/packethandler.hxx automation/source/simplecm/simplecm.cxx avmedia/source/framework/soundhandler.cxx basegfx/inc/basegfx/range/rangeexpander.hxx basic/inc/basic/sbxdef.hxx basic/source/classes/sbunoobj.cxx basic/source/classes/sbxmod.cxx basic/source/comp/dim.cxx basic/source/comp/exprgen.cxx basic/source/runtime/step1.cxx basic/source/runtime/step2.cxx basic/source/sbx/sbxint.cxx basic/source/uno/namecont.cxx basic/workben/mgrtest.cxx bean/com/sun/star/beans/LocalOfficeConnection.java bean/com/sun/star/beans/LocalOfficeWindow.java bean/com/sun/star/comp/beans/LocalOfficeConnection.java bean/com/sun/star/comp/beans/LocalOfficeWindow.java bean/com/sun/star/comp/beans/OOoBean.java bridges/inc/bridges/cpp_uno/bridge.hxx bridges/source/cpp_uno/cc50_solaris_intel/cpp2uno.cxx bridges/source/cpp_uno/cc50_solaris_intel/except.cxx bridges/source/cpp_uno/cc50_solaris_intel/uno2cpp.cxx bridges/source/cpp_uno/cc50_solaris_sparc/cpp2uno.cxx bridges/source/cpp_uno/cc50_solaris_sparc/except.cxx bridges/source/cpp_uno/cc50_solaris_sparc/uno2cpp.cxx bridges/source/cpp_uno/gcc3_linux_x86-64/uno2cpp.cxx bridges/source/cpp_uno/gcc3_macosx_powerpc/cpp2uno.cxx bridges/source/cpp_uno/gcc3_macosx_x86-64/uno2cpp.cxx bridges/source/cpp_uno/gcc3_netbsd_intel/cpp2uno.cxx bridges/source/cpp_uno/gcc3_netbsd_intel/except.cxx bridges/source/cpp_uno/gcc3_netbsd_intel/uno2cpp.cxx bridges/source/cpp_uno/gcc3_os2_intel/cpp2uno.cxx bridges/source/cpp_uno/gcc3_os2_intel/except.cxx bridges/source/cpp_uno/gcc3_os2_intel/uno2cpp.cxx bridges/source/cpp_uno/mingw_x86-64/uno2cpp.cxx bridges/source/cpp_uno/msvc_win32_intel/except.cxx bridges/source/cpp_uno/s5abi_macosx_x86-64/except.cxx bridges/source/cpp_uno/shared/component.cxx bridges/source/jni_uno/jni_base.h bridges/source/jni_uno/jni_bridge.cxx bridges/source/jni_uno/jni_java2uno.cxx bridges/source/jni_uno/jni_uno2java.cxx canvas/inc/canvas/base/doublebitmapbase.hxx canvas/inc/canvas/base/floatbitmapbase.hxx canvas/inc/canvas/base/integerbitmapbase.hxx canvas/source/cairo/cairo_canvasbitmap.cxx canvas/source/cairo/cairo_textlayout.cxx chart2/source/controller/dialogs/ObjectNameProvider.cxx chart2/source/view/diagram/VDiagram.cxx chart2/source/view/main/ChartView.cxx cli_ure/source/native/makefile.mk cli_ure/source/uno_bridge/cli_data.cxx codemaker/source/javamaker/javatype.cxx comphelper/inc/comphelper/componentcontext.hxx comphelper/inc/comphelper/interaction.hxx comphelper/inc/comphelper/locale.hxx comphelper/inc/comphelper/string.hxx comphelper/source/container/embeddedobjectcontainer.cxx comphelper/source/misc/accessiblecontexthelper.cxx comphelper/source/misc/asyncnotification.cxx comphelper/source/misc/locale.cxx comphelper/source/misc/mediadescriptor.cxx comphelper/source/misc/numberedcollection.cxx comphelper/source/misc/proxyaggregation.cxx comphelper/source/misc/scopeguard.cxx comphelper/source/misc/sequenceashashmap.cxx configure.in connectivity/source/commontools/parameters.cxx connectivity/source/drivers/dbase/DTable.cxx connectivity/source/drivers/evoab2/NStatement.cxx connectivity/source/drivers/file/FPreparedStatement.cxx connectivity/source/drivers/jdbc/DatabaseMetaData.cxx connectivity/source/inc/flat/ETable.hxx connectivity/source/parse/sqlnode.cxx cosv/inc/cosv/persist.hxx cosv/inc/cosv/ploc_dir.hxx cosv/inc/cosv/tpl/dyn.hxx cppu/source/LogBridge/LogBridge.cxx cppu/source/uno/data.cxx cppuhelper/source/bootstrap.cxx cppuhelper/source/component_context.cxx cppuhelper/source/propshlp.cxx cppuhelper/source/servicefactory.cxx cpputools/source/registercomponent/registercomponent.cxx cui/source/customize/acccfg.cxx cui/source/dialogs/about.cxx cui/source/dialogs/commonlingui.hxx cui/source/dialogs/showcols.cxx cui/source/inc/cuihyperdlg.hxx cui/source/inc/cuitabline.hxx cui/source/options/optsave.src cui/source/tabpages/tpline.cxx cui/source/tabpages/transfrm.cxx dbaccess/source/core/api/CacheSet.cxx dbaccess/source/core/api/KeySet.cxx dbaccess/source/core/api/RowSet.cxx dbaccess/source/core/api/RowSet.hxx dbaccess/source/core/api/RowSetBase.cxx dbaccess/source/core/api/RowSetBase.hxx dbaccess/source/core/api/RowSetCache.cxx dbaccess/source/core/api/querycomposer.cxx dbaccess/source/ext/adabas/Acomponentmodule.hxx dbaccess/source/ui/app/AppControllerDnD.cxx dbaccess/source/ui/app/AppDetailView.cxx dbaccess/source/ui/browser/brwctrlr.cxx dbaccess/source/ui/browser/sbagrid.cxx dbaccess/source/ui/browser/unodatbr.cxx dbaccess/source/ui/dlg/AdabasStat.hxx dbaccess/source/ui/dlg/UserAdmin.cxx dbaccess/source/ui/dlg/directsql.cxx dbaccess/source/ui/dlg/generalpage.hxx dbaccess/source/ui/dlg/tablespage.cxx dbaccess/source/ui/inc/JoinTableView.hxx dbaccess/source/ui/inc/TableController.hxx dbaccess/source/ui/inc/UITools.hxx dbaccess/source/ui/inc/brwctrlr.hxx dbaccess/source/ui/inc/datasourcemap.hxx dbaccess/source/ui/querydesign/JoinTableView.cxx dbaccess/source/ui/querydesign/QueryDesignView.cxx dbaccess/source/ui/querydesign/SelectionBrowseBox.cxx dbaccess/source/ui/querydesign/TableWindow.cxx dbaccess/source/ui/querydesign/querycontroller.cxx dbaccess/source/ui/relationdesign/RelationTableView.cxx dbaccess/source/ui/tabledesign/TableController.cxx desktop/source/app/app.cxx desktop/source/app/appinit.cxx desktop/source/app/langselect.cxx desktop/source/app/officeipcthread.cxx desktop/source/deployment/manager/dp_extensionmanager.cxx desktop/source/deployment/misc/dp_misc.cxx desktop/source/deployment/misc/dp_resource.cxx desktop/source/deployment/registry/dp_backend.cxx desktop/source/deployment/registry/package/dp_package.cxx desktop/source/migration/cfgfilter.cxx desktop/source/migration/migration.cxx desktop/source/splash/splash.cxx desktop/win32/source/QuickStart/QuickStart.cpp desktop/win32/source/setup/setup.cpp drawinglayer/source/processor2d/vclmetafileprocessor2d.cxx dtrans/source/win32/clipb/MtaOleClipb.hxx dtrans/source/win32/clipb/WinClipbImpl.cxx editeng/source/editeng/editview.cxx editeng/source/editeng/impedit2.cxx editeng/source/editeng/impedit3.cxx editeng/source/editeng/impedit4.cxx editeng/source/editeng/textconv.hxx editeng/source/misc/unolingu.cxx embeddedobj/source/commonembedding/persistence.cxx embeddedobj/source/general/dummyobject.cxx embeddedobj/source/msole/olecomponent.cxx embeddedobj/source/msole/olepersist.cxx embeddedobj/test/Container1/NativeView.java extensions/source/bibliography/framectr.cxx extensions/source/macosx/spotlight/OOoContentDataParser.m extensions/source/macosx/spotlight/unzip.h extensions/source/macosx/spotlight/unzip.m extensions/source/oooimprovement/myconfigurationhelper.hxx extensions/source/propctrlr/eventhandler.cxx extensions/source/propctrlr/formcomponenthandler.cxx extensions/source/propctrlr/pcrcomponentcontext.hxx extensions/source/scanner/twain.cxx extensions/source/update/check/updatecheckconfig.hxx external/mingwheaders/mingw_atl_headers.patch extras/source/misc_config/wizard/web/layouts/source.xml.xsl fileaccess/source/FileAccess.cxx filter/inc/filter/msfilter/msocximex.hxx filter/inc/filter/msfilter/svxmsbas.hxx filter/qa/complex/filter/detection/typeDetection/Helper.java filter/source/config/cache/basecontainer.cxx filter/source/config/cache/cacheitem.hxx filter/source/config/cache/contenthandlerfactory.cxx filter/source/config/cache/filtercache.cxx filter/source/config/cache/filtercache.hxx filter/source/config/cache/filterfactory.cxx filter/source/config/cache/frameloaderfactory.cxx filter/source/config/cache/querytokenizer.hxx filter/source/config/cache/typedetection.cxx filter/source/config/cache/typedetection.hxx filter/source/config/cache/versions.hxx filter/source/config/fragments/makefile.mk filter/source/config/tools/merge/pyAltFCFGMerge filter/source/flash/swfwriter.cxx filter/source/flash/swfwriter1.cxx filter/source/msfilter/msdffimp.cxx filter/source/msfilter/msocximex.cxx filter/source/msfilter/msvbahelper.cxx filter/source/msfilter/svxmsbas.cxx filter/source/xmlfilterdetect/filterdetect.cxx filter/source/xslt/import/uof2/uof2odf.xsl filter/source/xslt/odf2xhtml/export/xhtml/body.xsl filter/source/xsltfilter/com/sun/star/comp/xsltfilter/Base64.java forms/source/xforms/convert.hxx forms/source/xforms/model.cxx fpicker/source/aqua/SalAquaFilePicker.mm fpicker/source/office/fpinteraction.cxx fpicker/source/unx/gnome/SalGtkFolderPicker.cxx fpicker/source/unx/kde4/KDE4FilePicker.cxx fpicker/source/win32/filepicker/PreviewCtrl.cxx fpicker/source/win32/filepicker/PreviewCtrl.hxx fpicker/source/win32/filepicker/VistaFilePicker.cxx fpicker/source/win32/filepicker/VistaFilePickerImpl.hxx fpicker/source/win32/filepicker/helppopupwindow.hxx fpicker/source/win32/folderpicker/MtaFop.hxx framework/inc/classes/droptargetlistener.hxx framework/inc/classes/filtercache.hxx framework/inc/classes/filtercachedata.hxx framework/inc/classes/protocolhandlercache.hxx framework/inc/classes/servicemanager.hxx framework/inc/commands.h framework/inc/dispatch/basedispatcher.hxx framework/inc/dispatch/blankdispatcher.hxx framework/inc/dispatch/closedispatcher.hxx framework/inc/dispatch/createdispatcher.hxx framework/inc/dispatch/dispatchprovider.hxx framework/inc/dispatch/helpagentdispatcher.hxx framework/inc/dispatch/mailtodispatcher.hxx framework/inc/dispatch/menudispatcher.hxx framework/inc/dispatch/oxt_handler.hxx framework/inc/dispatch/popupmenudispatcher.hxx framework/inc/dispatch/selfdispatcher.hxx framework/inc/dispatch/servicehandler.hxx framework/inc/dispatch/startmoduledispatcher.hxx framework/inc/dispatch/systemexec.hxx framework/inc/helper/fixeddocumentproperties.hxx framework/inc/helper/ocomponentaccess.hxx framework/inc/helper/oframes.hxx framework/inc/helper/otasksenumeration.hxx framework/inc/helper/persistentwindowstate.hxx framework/inc/helper/statusindicator.hxx framework/inc/helper/statusindicatorfactory.hxx framework/inc/helper/tagwindowasmodified.hxx framework/inc/helper/titlebarupdate.hxx framework/inc/helper/vclstatusindicator.hxx framework/inc/interaction/quietinteraction.hxx framework/inc/jobs/helponstartup.hxx framework/inc/jobs/job.hxx framework/inc/jobs/jobdata.hxx framework/inc/jobs/jobexecutor.hxx framework/inc/loadstate.h framework/inc/macros/debug/assertion.hxx framework/inc/macros/debug/event.hxx framework/inc/macros/debug/filterdbg.hxx framework/inc/macros/debug/memorymeasure.hxx framework/inc/macros/debug/timemeasure.hxx framework/inc/macros/xserviceinfo.hxx framework/inc/queries.h framework/inc/recording/dispatchrecordersupplier.hxx framework/inc/services/autorecovery.hxx framework/inc/services/backingcomp.hxx framework/inc/services/contenthandlerfactory.hxx framework/inc/services/desktop.hxx framework/inc/services/detectorfactory.hxx framework/inc/services/frame.hxx framework/inc/services/frameloaderfactory.hxx framework/inc/services/layoutmanager.hxx framework/inc/services/license.hxx framework/inc/services/logindialog.hxx framework/inc/services/modulemanager.hxx framework/inc/services/pathsettings.hxx framework/inc/services/pluginframe.hxx framework/inc/services/substitutepathvars.hxx framework/inc/services/task.hxx framework/inc/services/taskcreatorsrv.hxx framework/inc/stdtypes.h framework/inc/threadhelp/fairrwlock.hxx framework/inc/threadhelp/inoncopyable.h framework/inc/threadhelp/itransactionmanager.h framework/inc/threadhelp/lockhelper.hxx framework/inc/threadhelp/readguard.hxx framework/inc/threadhelp/resetableguard.hxx framework/inc/threadhelp/transactionguard.hxx framework/inc/threadhelp/writeguard.hxx framework/inc/uifactory/uielementfactorymanager.hxx framework/inc/xml/acceleratorconfigurationreader.hxx framework/qa/complex/dispatches/checkdispatchapi.java framework/qa/complex/framework/autosave/AutoSave.java framework/qa/complex/framework/autosave/Protocol.java framework/qa/complex/framework/recovery/RecoveryTest.java framework/qa/complex/loadAllDocuments/StreamSimulator.java framework/source/accelerators/acceleratorconfiguration.cxx framework/source/accelerators/acceleratorexecute.cxx framework/source/accelerators/acceleratorexecute.hxx framework/source/accelerators/keymapping.cxx framework/source/accelerators/presethandler.cxx framework/source/application/framework.cxx framework/source/application/login.cxx framework/source/classes/framecontainer.cxx framework/source/classes/menumanager.cxx framework/source/classes/taskcreator.cxx framework/source/dispatch/closedispatcher.cxx framework/source/dispatch/dispatchprovider.cxx framework/source/dispatch/helpagentdispatcher.cxx framework/source/dispatch/interceptionhelper.cxx framework/source/dispatch/mailtodispatcher.cxx framework/source/dispatch/menudispatcher.cxx framework/source/dispatch/oxt_handler.cxx framework/source/dispatch/servicehandler.cxx framework/source/fwe/classes/framelistanalyzer.cxx framework/source/fwe/dispatch/interaction.cxx framework/source/fwe/helper/titlehelper.cxx framework/source/fwe/helper/undomanagerhelper.cxx framework/source/fwe/xml/eventsdocumenthandler.cxx framework/source/fwe/xml/statusbardocumenthandler.cxx framework/source/fwe/xml/toolboxdocumenthandler.cxx framework/source/fwi/classes/protocolhandlercache.cxx framework/source/fwi/threadhelp/lockhelper.cxx framework/source/fwi/threadhelp/transactionmanager.cxx framework/source/helper/persistentwindowstate.cxx framework/source/helper/statusindicatorfactory.cxx framework/source/helper/vclstatusindicator.cxx framework/source/inc/accelerators/acceleratorcache.hxx framework/source/inc/accelerators/acceleratorconfiguration.hxx framework/source/inc/accelerators/presethandler.hxx framework/source/inc/accelerators/storageholder.hxx framework/source/inc/loadenv/actionlockguard.hxx framework/source/inc/loadenv/loadenv.hxx framework/source/inc/loadenv/loadenvexception.hxx framework/source/inc/pattern/frame.hxx framework/source/inc/pattern/storages.hxx framework/source/inc/pattern/window.hxx framework/source/jobs/helponstartup.cxx framework/source/jobs/job.cxx framework/source/jobs/jobdata.cxx framework/source/jobs/jobdispatch.cxx framework/source/jobs/jobresult.cxx framework/source/jobs/joburl.cxx framework/source/jobs/shelljob.cxx framework/source/loadenv/loadenv.cxx framework/source/services/autorecovery.cxx framework/source/services/backingwindow.cxx framework/source/services/desktop.cxx framework/source/services/frame.cxx framework/source/services/modulemanager.cxx framework/source/services/pathsettings.cxx framework/source/services/substitutepathvars.cxx framework/source/uiconfiguration/moduleuicfgsupplier.cxx framework/source/uiconfiguration/moduleuiconfigurationmanager.cxx framework/source/uiconfiguration/uicategorydescription.cxx framework/source/uiconfiguration/uiconfigurationmanagerimpl.cxx framework/source/uiconfiguration/windowstateconfiguration.cxx framework/source/uielement/uicommanddescription.cxx framework/source/unotypes/fwk.xml framework/source/xml/imagesdocumenthandler.cxx framework/test/test.cxx framework/test/test_componentenumeration.bas framework/test/test_statusindicatorfactory.bas framework/test/threadtest.cxx framework/test/threadtest/threadtest.cxx framework/test/typecfg/cfgview.cxx framework/test/typecfg/xml2xcd.cxx include/basegfx/polygon/b2dpolygon.hxx include/canvas/base/graphicdevicebase.hxx include/canvas/canvastools.hxx include/comphelper/configurationhelper.hxx include/comphelper/embeddedobjectcontainer.hxx include/comphelper/propagg.hxx include/comphelper/sequenceashashmap.hxx include/connectivity/sqlerror.hxx include/connectivity/sqlnode.hxx include/cppuhelper/propshlp.hxx include/editeng/AccessibleContextBase.hxx include/framework/framelistanalyzer.hxx sfx2/source/dialog/backingcomp.cxx vcl/unx/gtk/fpicker/SalGtkFilePicker.cxx Change-Id: I2618bf83c0e30f68f23ff25f6eb466df04d34c6d
2014-04-29 19:05:05 +00:00
every time the canvas API semantically changes the content of
the canvas, CanvasHelper::modifying() will get called
(<em>before</em> the actual modification takes place).
@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 CanvasHelper,
class Mutex=::osl::MutexGuard,
class UnambiguousBase=css::uno::XInterface > class CanvasBase :
public Base
{
public:
typedef Base BaseType;
typedef CanvasHelper HelperType;
typedef Mutex MutexType;
typedef UnambiguousBase UnambiguousBaseType;
/** Create CanvasBase
*/
CanvasBase() :
maCanvasHelper(),
mbSurfaceDirty( true )
{
}
virtual void disposeThis() override
{
MutexType aGuard( BaseType::m_aMutex );
maCanvasHelper.disposing();
// pass on to base class
BaseType::disposeThis();
}
// XCanvas
virtual void SAL_CALL clear() throw (css::uno::RuntimeException, std::exception) override
{
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
maCanvasHelper.clear();
}
virtual void SAL_CALL drawPoint(const css::geometry::RealPoint2D& aPoint,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState)
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(aPoint, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
}
virtual void SAL_CALL drawLine(const css::geometry::RealPoint2D& aStartPoint,
const css::geometry::RealPoint2D& aEndPoint,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState)
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(aStartPoint, aEndPoint, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
maCanvasHelper.drawLine( this, aStartPoint, aEndPoint, viewState, renderState );
}
virtual void SAL_CALL drawBezier( const css::geometry::RealBezierSegment2D& aBezierSegment,
const css::geometry::RealPoint2D& aEndPoint,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState )
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(aBezierSegment, aEndPoint, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
maCanvasHelper.drawBezier( this, aBezierSegment, aEndPoint, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawPolyPolygon(const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState)
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawPolyPolygon( this, xPolyPolygon, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
strokePolyPolygon(const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::rendering::StrokeAttributes& strokeAttributes)
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, strokeAttributes,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.strokePolyPolygon( this, xPolyPolygon, viewState, renderState, strokeAttributes );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
strokeTexturedPolyPolygon( const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence< css::rendering::Texture >& textures,
const css::rendering::StrokeAttributes& strokeAttributes ) throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, strokeAttributes,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.strokeTexturedPolyPolygon( this, xPolyPolygon, viewState, renderState, textures, strokeAttributes );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
strokeTextureMappedPolyPolygon( const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence< css::rendering::Texture >& textures,
const css::uno::Reference< css::geometry::XMapping2D >& xMapping,
const css::rendering::StrokeAttributes& strokeAttributes ) throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, textures, xMapping, strokeAttributes,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.strokeTextureMappedPolyPolygon( this, xPolyPolygon, viewState, renderState, textures, xMapping, strokeAttributes );
}
virtual css::uno::Reference< css::rendering::XPolyPolygon2D > SAL_CALL
queryStrokeShapes( const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::rendering::StrokeAttributes& strokeAttributes ) throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, strokeAttributes,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.queryStrokeShapes( this, xPolyPolygon, viewState, renderState, strokeAttributes );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
fillPolyPolygon(const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState)
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.fillPolyPolygon( this, xPolyPolygon, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
fillTexturedPolyPolygon(const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence< css::rendering::Texture >& textures)
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, textures,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.fillTexturedPolyPolygon( this, xPolyPolygon, viewState, renderState, textures );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
fillTextureMappedPolyPolygon( const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence< css::rendering::Texture >& textures,
const css::uno::Reference< css::geometry::XMapping2D >& xMapping ) throw (css::lang::IllegalArgumentException, css::uno::RuntimeException) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, textures, xMapping,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.fillTextureMappedPolyPolygon( this, xPolyPolygon, viewState, renderState, textures, xMapping );
}
virtual css::uno::Reference< css::rendering::XCanvasFont > SAL_CALL
createFont( const css::rendering::FontRequest& fontRequest,
const css::uno::Sequence< css::beans::PropertyValue >& extraFontProperties,
const css::geometry::Matrix2D& fontMatrix ) throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException) override
{
tools::verifyArgs(fontRequest,
// dummy, to keep argPos in sync
fontRequest,
fontMatrix,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
return maCanvasHelper.createFont( this, fontRequest, extraFontProperties, fontMatrix );
}
virtual css::uno::Sequence< css::rendering::FontInfo > SAL_CALL
queryAvailableFonts( const css::rendering::FontInfo& aFilter,
const css::uno::Sequence< css::beans::PropertyValue >& aFontProperties ) throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException) override
{
tools::verifyArgs(aFilter,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
return maCanvasHelper.queryAvailableFonts( this, aFilter, aFontProperties );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawText(const css::rendering::StringContext& text,
const css::uno::Reference< css::rendering::XCanvasFont >& xFont,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
sal_Int8 textDirection)
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(xFont, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
tools::verifyRange( textDirection,
css::rendering::TextDirection::WEAK_LEFT_TO_RIGHT,
css::rendering::TextDirection::STRONG_RIGHT_TO_LEFT );
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawText( this, text, xFont, viewState, renderState, textDirection );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawTextLayout(const css::uno::Reference< css::rendering::XTextLayout >& laidOutText,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState)
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException,
std::exception) override
{
tools::verifyArgs(laidOutText, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawTextLayout( this, laidOutText, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawBitmap( const css::uno::Reference< css::rendering::XBitmap >& xBitmap,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState ) throw (css::lang::IllegalArgumentException, css::uno::RuntimeException) override
{
tools::verifyArgs(xBitmap, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawBitmap( this, xBitmap, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawBitmapModulated( const css::uno::Reference< css::rendering::XBitmap >& xBitmap,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState ) throw (css::lang::IllegalArgumentException, css::uno::RuntimeException) override
{
tools::verifyArgs(xBitmap, viewState, renderState,
OSL_THIS_FUNC,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawBitmapModulated( this, xBitmap, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XGraphicDevice > SAL_CALL
getDevice() throw (css::uno::RuntimeException) override
{
MutexType aGuard( BaseType::m_aMutex );
return maCanvasHelper.getDevice();
}
protected:
~CanvasBase() {} // we're a ref-counted UNO class. _We_ destroy ourselves.
HelperType maCanvasHelper;
mutable bool mbSurfaceDirty;
private:
CanvasBase( const CanvasBase& ) = delete;
CanvasBase& operator=( const CanvasBase& ) = delete;
};
}
#endif // INCLUDED_CANVAS_BASE_CANVASBASE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */