sfx2/source/appl/imestatuswindow.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #if !defined INCLUDED_SFX2_APPL_IMESTATUSWINDOW_HXX
  30 #define INCLUDED_SFX2_APPL_IMESTATUSWINDOW_HXX
  31
  32 #include "com/sun/star/beans/XPropertyChangeListener.hpp"
  33 #include "com/sun/star/uno/Reference.hxx"
  34 #include "cppuhelper/implbase1.hxx"
  35 #include "osl/mutex.hxx"
  36
  37 namespace com { namespace sun { namespace star {
  38     namespace beans { class XPropertySet; }
  39     namespace lang { class XMultiServiceFactory; }
  40 } } }
  41
  42 namespace sfx2 { namespace appl {
  43
  44 // The MS compiler needs this typedef work-around to accept the using
  45 // declarations within ImeStatusWindow:
  46 typedef cppu::WeakImplHelper1< com::sun::star::beans::XPropertyChangeListener >
  47 ImeStatusWindow_Impl;
  48
  49 /** Control the behavior of any (platform-dependent) IME status windows.
  50
  51     The decision of whether a status window shall be displayed or not can be
  52     stored permanently in the configuration (under key
  53     org.openoffice.office.Common/I18N/InputMethod/ShowStatusWindow; if that
  54     entry is nil, VCL is asked for a default).
  55  */
  56 class ImeStatusWindow: private ImeStatusWindow_Impl
  57 {
  58 public:
  59     ImeStatusWindow( com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory > const& rServiceFactory );
  60
  61     /** Set up VCL according to the configuration.
  62
  63         Is it not strictly required that this method is called exactly once
  64         (though that will be the typical use).
  65
  66         Must only be called with the Solar mutex locked.
  67      */
  68     void init();
  69
  70     /** Return true if the status window is toggled on.
  71
  72         This is only meaningful when canToggle returns true.
  73
  74         Can be called without the Solar mutex locked.
  75      */
  76     bool isShowing();
  77
  78     /** Toggle the status window on or off.
  79
  80         This only works if canToggle returns true (otherwise, any calls of this
  81         method are ignored).
  82
  83         Must only be called with the Solar mutex locked.
  84      */
  85     void show(bool bShow);
  86
  87     /** Return true if the status window can be toggled on and off externally.
  88
  89         Must only be called with the Solar mutex locked.
  90      */
  91     bool canToggle() const;
  92
  93     using ImeStatusWindow_Impl::acquire;
  94     using ImeStatusWindow_Impl::release;
  95     using ImeStatusWindow_Impl::operator new;
  96     using ImeStatusWindow_Impl::operator delete;
  97
  98 private:
  99     ImeStatusWindow(ImeStatusWindow &); // not implemented
 100     void operator =(ImeStatusWindow); // not implemented
 101
 102     virtual ~ImeStatusWindow();
 103
 104     virtual void SAL_CALL
 105     disposing(com::sun::star::lang::EventObject const & rSource)
 106         throw (com::sun::star::uno::RuntimeException);
 107
 108     virtual void SAL_CALL
 109     propertyChange(com::sun::star::beans::PropertyChangeEvent const & rEvent)
 110         throw (com::sun::star::uno::RuntimeException);
 111
 112     com::sun::star::uno::Reference< com::sun::star::beans::XPropertySet >
 113     getConfig();
 114
 115     com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >
 116         m_xServiceFactory;
 117
 118     osl::Mutex m_aMutex;
 119     com::sun::star::uno::Reference< com::sun::star::beans::XPropertySet >
 120         m_xConfig;
 121     com::sun::star::uno::Reference< com::sun::star::beans::XPropertyChangeListener >
 122         m_xConfigListener;
 123     bool m_bDisposed;
 124 };
 125
 126 } }
 127
 128 #endif // INCLUDED_SFX2_APPL_IMESTATUSWINDOW_HXX
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */