svtools/inc/helpagentwindow.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: helpagentwindow.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SVTOOLS_HELPAGENTWIDNOW_HXX_
  32 #define _SVTOOLS_HELPAGENTWIDNOW_HXX_
  33
  34 #include "svtools/svtdllapi.h"
  35 #include <vcl/floatwin.hxx>
  36 #include <vcl/image.hxx>
  37
  38 //........................................................................
  39 namespace svt
  40 {
  41 //........................................................................
  42
  43     //====================================================================
  44     //= IHelpAgentCallback
  45     //====================================================================
  46     class IHelpAgentCallback
  47     {
  48     public:
  49         virtual void helpRequested() = 0;
  50         virtual void closeAgent() = 0;
  51     };
  52
  53     //====================================================================
  54     //= HelpAgentWindow
  55     //====================================================================
  56     class SVT_DLLPUBLIC HelpAgentWindow : public FloatingWindow
  57     {
  58     protected:
  59         Window*                                 m_pCloser;
  60         IHelpAgentCallback*             m_pCallback;
  61         Size                                    m_aPreferredSize;
  62         Image                                   m_aPicture;
  63
  64     public:
  65         HelpAgentWindow( Window* _pParent );
  66         ~HelpAgentWindow();
  67
  68         /// returns the preferred size of the window
  69         const Size& getPreferredSizePixel() const { return m_aPreferredSize; }
  70
  71         // callback handler maintainance
  72         void                            setCallback(IHelpAgentCallback* _pCB) { m_pCallback = _pCB; }
  73         IHelpAgentCallback*     getCallback() const { return m_pCallback; }
  74
  75     protected:
  76         virtual void Resize();
  77         virtual void Paint( const Rectangle& rRect );
  78         virtual void MouseButtonUp( const MouseEvent& rMEvt );
  79
  80         DECL_LINK( OnButtonClicked, Window* );
  81
  82     private:
  83         SVT_DLLPRIVATE Size     implOptimalButtonSize( const Image& _rButtonImage );
  84     };
  85
  86 //........................................................................
  87 }       // namespace svt
  88 //........................................................................
  89
  90 #endif  // _SVTOOLS_HELPAGENTWIDNOW_HXX_
  91