sdext/source/presenter/PresenterHelpView.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PresenterHelpView.hxx,v $
  10  *
  11  * $Revision: 1.4 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef SDEXT_PRESENTER_HELP_VIEW_HXX
  33 #define SDEXT_PRESENTER_HELP_VIEW_HXX
  34
  35 #include "PresenterController.hxx"
  36 #include <cppuhelper/basemutex.hxx>
  37 #include <cppuhelper/compbase3.hxx>
  38 #include <com/sun/star/awt/XPaintListener.hpp>
  39 #include <com/sun/star/awt/XWindowListener.hpp>
  40 #include <com/sun/star/drawing/framework/XView.hpp>
  41 #include <com/sun/star/drawing/framework/XResourceId.hpp>
  42 #include <com/sun/star/frame/XController.hpp>
  43 #include <com/sun/star/rendering/XSpriteCanvas.hpp>
  44
  45 namespace css = ::com::sun::star;
  46
  47 namespace {
  48     typedef cppu::WeakComponentImplHelper3<
  49         css::drawing::framework::XView,
  50         css::awt::XWindowListener,
  51         css::awt::XPaintListener
  52         > PresenterHelpViewInterfaceBase;
  53 }
  54
  55 namespace sdext { namespace presenter {
  56
  57 class PresenterButton;
  58
  59 /** Show help text that describes the defined keys.
  60 */
  61 class PresenterHelpView
  62     : private ::cppu::BaseMutex,
  63       public PresenterHelpViewInterfaceBase
  64 {
  65 public:
  66     explicit PresenterHelpView (
  67         const css::uno::Reference<css::uno::XComponentContext>& rxContext,
  68         const css::uno::Reference<css::drawing::framework::XResourceId>& rxViewId,
  69         const css::uno::Reference<css::frame::XController>& rxController,
  70         const ::rtl::Reference<PresenterController>& rpPresenterController);
  71     virtual ~PresenterHelpView (void);
  72
  73     virtual void SAL_CALL disposing (void);
  74
  75     // lang::XEventListener
  76
  77     virtual void SAL_CALL
  78         disposing (const css::lang::EventObject& rEventObject)
  79         throw (css::uno::RuntimeException);
  80
  81
  82     // XWindowListener
  83
  84     virtual void SAL_CALL windowResized (const css::awt::WindowEvent& rEvent)
  85         throw (css::uno::RuntimeException);
  86
  87     virtual void SAL_CALL windowMoved (const css::awt::WindowEvent& rEvent)
  88         throw (css::uno::RuntimeException);
  89
  90     virtual void SAL_CALL windowShown (const css::lang::EventObject& rEvent)
  91         throw (css::uno::RuntimeException);
  92
  93     virtual void SAL_CALL windowHidden (const css::lang::EventObject& rEvent)
  94         throw (css::uno::RuntimeException);
  95
  96
  97     // XPaintListener
  98
  99     virtual void SAL_CALL windowPaint (const css::awt::PaintEvent& rEvent)
 100         throw (css::uno::RuntimeException);
 101
 102
 103     // XResourceId
 104
 105     virtual css::uno::Reference<css::drawing::framework::XResourceId> SAL_CALL getResourceId (void)
 106         throw (css::uno::RuntimeException);
 107
 108     virtual sal_Bool SAL_CALL isAnchorOnly (void)
 109         throw (com::sun::star::uno::RuntimeException);
 110
 111 private:
 112     class TextContainer;
 113
 114     css::uno::Reference<css::uno::XComponentContext> mxComponentContext;
 115     css::uno::Reference<css::drawing::framework::XResourceId> mxViewId;
 116     css::uno::Reference<css::drawing::framework::XPane> mxPane;
 117     css::uno::Reference<css::awt::XWindow> mxWindow;
 118     css::uno::Reference<css::rendering::XCanvas> mxCanvas;
 119     ::rtl::Reference<PresenterController> mpPresenterController;
 120     PresenterTheme::SharedFontDescriptor mpFont;
 121     ::boost::scoped_ptr<TextContainer> mpTextContainer;
 122     ::rtl::Reference<PresenterButton> mpCloseButton;
 123     sal_Int32 mnSeparatorY;
 124     sal_Int32 mnMaximalWidth;
 125
 126     void ProvideCanvas (void);
 127     void Resize (void);
 128     void Paint (const css::awt::Rectangle& rRedrawArea);
 129     void ReadHelpStrings (void);
 130     void ProcessString (
 131         const css::uno::Reference<css::beans::XPropertySet>& rsProperties);
 132
 133     /** Find a font size, so that all text can be displayed at the same
 134         time.
 135     */
 136     void CheckFontSize (void);
 137
 138     /** This method throws a DisposedException when the object has already been
 139         disposed.
 140     */
 141     void ThrowIfDisposed (void)
 142         throw (css::lang::DisposedException);
 143 };
 144
 145 } } // end of namespace ::sdext::presenter
 146
 147 #endif