sdext/source/presenter/PresenterPaintManager.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: PresenterPaintManager.hxx,v $
  10  *
  11  * $Revision: 1.2 $
  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_PRESENTER_PAINT_MANAGER_HXX
  33 #define SDEXT_PRESENTER_PRESENTER_PAINT_MANAGER_HXX
  34
  35 #include <com/sun/star/awt/XWindow.hpp>
  36 #include <com/sun/star/awt/XWindowPeer.hpp>
  37 #include <com/sun/star/drawing/XPresenterHelper.hpp>
  38 #include <rtl/ref.hxx>
  39
  40 namespace css = ::com::sun::star;
  41
  42 namespace sdext { namespace presenter {
  43
  44 class PresenterPaneContainer;
  45
  46 /** Synchronize painting of windows and canvases.  At the moment there is
  47     just some processing of invalidate calls.
  48     This could be extended to process incoming windowPaint() calls.
  49 */
  50 class PresenterPaintManager
  51 {
  52 public:
  53     /** Create paint manager with the window that is the top node in the
  54         local window hierarchy.
  55     */
  56     PresenterPaintManager (
  57         const css::uno::Reference<css::awt::XWindow>& rxParentWindow,
  58         const css::uno::Reference<css::drawing::XPresenterHelper>& rxPresenterHelper,
  59         const rtl::Reference<PresenterPaneContainer>& rpPaneContainer);
  60
  61     /** Request a repaint of the whole window.
  62         @param rxWindow
  63             May be the parent window or one of its descendents.
  64     */
  65     void Invalidate (
  66         const css::uno::Reference<css::awt::XWindow>& rxWindow,
  67         const bool bSynchronous = false);
  68     void Invalidate (
  69         const css::uno::Reference<css::awt::XWindow>& rxWindow,
  70         const sal_Int16 nInvalidateFlags);
  71
  72     /** Request a repaint of a part of a window.
  73         @param rxWindow
  74             May be the parent window or one of its descendents.
  75     */
  76     void Invalidate (
  77         const css::uno::Reference<css::awt::XWindow>& rxWindow,
  78         const css::awt::Rectangle& rRepaintBox,
  79         const bool bSynchronous = false);
  80     void Invalidate (
  81         const css::uno::Reference<css::awt::XWindow>& rxWindow,
  82         const css::awt::Rectangle& rRepaintBox,
  83         const sal_Int16 nInvalidateFlags);
  84
  85 private:
  86     css::uno::Reference<css::awt::XWindow> mxParentWindow;
  87     css::uno::Reference<css::awt::XWindowPeer> mxParentWindowPeer;
  88     css::uno::Reference<css::drawing::XPresenterHelper> mxPresenterHelper;
  89     ::rtl::Reference<PresenterPaneContainer> mpPaneContainer;
  90 };
  91
  92 } }
  93
  94 #endif