vcl/unx/inc/i18n_status.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: i18n_status.hxx,v $
  10  * $Revision: 1.12 $
  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 _SAL_I18N_STATUS_HXX
  32 #define _SAL_I18N_STATUS_HXX
  33
  34 #include <tools/string.hxx>
  35 #include <tools/link.hxx>
  36 #include <tools/gen.hxx>
  37
  38 #ifndef _RTL_USTRING_HXX
  39 #include <rtl/ustring.hxx>
  40 #endif
  41 #include <vcl/salimestatus.hxx>
  42
  43 #include <vector>
  44
  45 class SalFrame;
  46 class WorkWindow;
  47 class ListBox;
  48 class FixedText;
  49 class PushButton;
  50 class SalI18N_InputContext;
  51
  52 namespace vcl
  53 {
  54
  55 class StatusWindow;
  56
  57 class X11ImeStatus : public SalI18NImeStatus
  58 {
  59 public:
  60     X11ImeStatus() {}
  61     virtual ~X11ImeStatus();
  62
  63     virtual bool canToggle();
  64     virtual void toggle();
  65 };
  66
  67 class I18NStatus
  68 {
  69 public:
  70     struct ChoiceData
  71     {
  72         String  aString;
  73         void*   pData;
  74     };
  75 private:
  76     SalFrame*                                   m_pParent;
  77     StatusWindow*                               m_pStatusWindow;
  78     String                                              m_aCurrentIM;
  79     ::std::vector< ChoiceData >     m_aChoices;
  80
  81     I18NStatus();
  82     ~I18NStatus();
  83
  84     static I18NStatus* pInstance;
  85
  86     static bool getStatusWindowMode();
  87
  88 public:
  89     static I18NStatus& get();
  90     static bool exists();
  91     static void free();
  92
  93     void setParent( SalFrame* pParent );
  94     SalFrame* getParent() const { return  m_pParent; }
  95     SalFrame* getStatusFrame() const;
  96
  97     void setStatusText( const String& rText );
  98     String getStatusText() const;
  99
 100     enum ShowReason { focus, presentation, contextmap };
 101     void show( bool bShow, ShowReason eReason );
 102
 103     const ::std::vector< ChoiceData >& getChoices() const { return m_aChoices; }
 104     void clearChoices();
 105     void addChoice( const String&, void* pData );
 106
 107     void toTop() const;
 108
 109     // for SwitchIMCallback
 110     void changeIM( const String& );
 111
 112     // External Control:
 113
 114     /** Return true if the status window can be toggled on and off externally.
 115      */
 116     bool canToggleStatusWindow() const;
 117
 118     /** Toggle the status window on or off.
 119
 120         This only works if canToggleStatusWindow returns true (otherwise, any
 121         calls of this method are ignored).
 122      */
 123     void toggleStatusWindow();
 124 };
 125
 126 } // namespace
 127
 128 #endif // _SAL_I18N_STATUS_HXX