include/toolkit/helper/vclunohelper.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_TOOLKIT_HELPER_VCLUNOHELPER_HXX
  21 #define INCLUDED_TOOLKIT_HELPER_VCLUNOHELPER_HXX
  22
  23 #include <toolkit/dllapi.h>
  24 #include <com/sun/star/uno/Reference.h>
  25
  26 #include <com/sun/star/awt/MouseEvent.hpp>
  27 #include <com/sun/star/awt/Rectangle.hpp>
  28
  29 #include <vcl/bitmapex.hxx>
  30 #include <vcl/font.hxx>
  31 #include <vcl/region.hxx>
  32 #include <tools/mapunit.hxx>
  33 #include <tools/fldunit.hxx>
  34 #include <tools/poly.hxx>
  35
  36
  37 namespace com::sun::star::uno { template <typename > class Sequence; }
  38
  39 namespace com::sun::star::uno {
  40     class XInterface;
  41 }
  42
  43 namespace com::sun::star::awt {
  44     class XBitmap;
  45     class XWindow;
  46     class XWindow2;
  47     class XWindowPeer;
  48     class XGraphics;
  49     class XRegion;
  50     class XDevice;
  51     class XToolkit;
  52     class XFont;
  53     class XControlContainer;
  54     struct Size;
  55     struct Point;
  56     struct SimpleFontMetric;
  57     struct FontDescriptor;
  58     struct Rectangle;
  59     struct KeyEvent;
  60 }
  61
  62
  63 enum class PointerStyle;
  64
  65 class FontMetric;
  66 class OutputDevice;
  67 class MouseEvent;
  68 class KeyEvent;
  69
  70 class TOOLKIT_DLLPUBLIC VCLUnoHelper
  71 {
  72 public:
  73     // Toolkit
  74     static css::uno::Reference< css::awt::XToolkit>   CreateToolkit();
  75
  76     // Bitmap
  77     static BitmapEx                                                         GetBitmap( const css::uno::Reference< css::awt::XBitmap>& rxBitmap );
  78     static css::uno::Reference< css::awt::XBitmap>    CreateBitmap( const BitmapEx& rBitmap );
  79
  80     // Window
  81     static vcl::Window*                               GetWindow( const css::uno::Reference< css::awt::XWindow>& rxWindow );
  82     static vcl::Window*                               GetWindow( const css::uno::Reference< css::awt::XWindow2>& rxWindow2 );
  83     static vcl::Window*                               GetWindow( const css::uno::Reference< css::awt::XWindowPeer>& rxWindowPeer );
  84     static css::uno::Reference< css::awt::XWindow>    GetInterface( vcl::Window* pWindow );
  85
  86     // OutputDevice
  87     static OutputDevice*                            GetOutputDevice( const css::uno::Reference< css::awt::XDevice>& rxDevice );
  88     static OutputDevice*                            GetOutputDevice( const css::uno::Reference< css::awt::XGraphics>& rxGraphics );
  89
  90     // Region
  91     static vcl::Region                                   GetRegion( const css::uno::Reference< css::awt::XRegion >& rxRegion );
  92
  93     // Polygon
  94     static tools::Polygon CreatePolygon( const css::uno::Sequence< sal_Int32 >& DataX, const css::uno::Sequence< sal_Int32 >& DataY );
  95
  96     /** convert Font to css::awt::FontDescriptor
  97         @param  rFont  Font to be converted
  98         @return the new FontDescriptor
  99     */
 100     static css::awt::FontDescriptor    CreateFontDescriptor( const vcl::Font& rFont );
 101     static vcl::Font                                CreateFont( const css::awt::FontDescriptor& rDescr, const vcl::Font& rInitFont );
 102     static vcl::Font                                CreateFont( const css::uno::Reference< css::awt::XFont >& rxFont );
 103     static css::awt::SimpleFontMetric  CreateFontMetric( const FontMetric& rFontMetric );
 104
 105     // Rectangle
 106     static bool                                     IsZero(const css::awt::Rectangle& rRect);
 107
 108     static css::uno::Reference< css::awt::XControlContainer>  CreateControlContainer( vcl::Window* pWindow );
 109
 110     // MapUnits
 111     static MapUnit                                  UnoEmbed2VCLMapUnit( sal_Int32 nUnoEmbedMapUnit );
 112     static sal_Int32                                VCL2UnoEmbedMapUnit( MapUnit nVCLMapUnit );
 113
 114
 115     //= MeasurementUnitConversion
 116
 117     /** small helper to convert between MeasurementUnit and
 118         FieldUnit
 119     */
 120     static sal_Int16                                ConvertToMeasurementUnit( FieldUnit _nFieldUnit, sal_Int16 _rFieldToUNOValueFactor );
 121     static FieldUnit                                ConvertToFieldUnit( sal_Int16 _nMeasurementUnit, sal_Int16& _rFieldToUNOValueFactor );
 122
 123     /// @throws css::lang::IllegalArgumentException
 124     static MapUnit /* MapModeUnit */ ConvertToMapModeUnit(sal_Int16 /* com.sun.star.util.MeasureUnit.* */ _nMeasureUnit);
 125
 126     static css::awt::MouseEvent
 127         createMouseEvent(
 128             const ::MouseEvent& _rVclEvent,
 129             const css::uno::Reference< css::uno::XInterface >& _rxContext
 130         );
 131
 132     static ::MouseEvent createVCLMouseEvent( const css::awt::MouseEvent& _rAwtEvent );
 133
 134     static css::awt::KeyEvent
 135         createKeyEvent(
 136             const ::KeyEvent& _rVclEvent,
 137             const css::uno::Reference< css::uno::XInterface >& _rxContext
 138         );
 139
 140     static ::KeyEvent createVCLKeyEvent( const css::awt::KeyEvent& _rAwtEvent );
 141
 142     static ::PointerStyle getMousePointer(const css::uno::Reference<css::awt::XWindowPeer>& rWindowPeer);
 143     static void setMousePointer(const css::uno::Reference<css::awt::XWindowPeer>& rWindowPeer, ::PointerStyle mousepointer);
 144 };
 145
 146 #endif // INCLUDED_TOOLKIT_HELPER_VCLUNOHELPER_HXX
 147
 148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */