LibreOffice Module vcl (master)  1
svapp.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef INCLUDED_VCL_SVAPP_HXX
21 #define INCLUDED_VCL_SVAPP_HXX
22 
23 #include <sal/config.h>
24 #include <sal/types.h>
25 
26 #include <cassert>
27 #include <vector>
28 
30 #include <osl/mutex.hxx>
31 #include <rtl/ustring.hxx>
32 #include <osl/thread.h>
33 #include <tools/gen.hxx>
34 #include <tools/link.hxx>
35 #include <tools/solar.h>
36 #include <vcl/dllapi.h>
37 #include <vcl/inputtypes.hxx>
38 #include <vcl/exceptiontypes.hxx>
39 #include <vcl/vclevent.hxx>
40 #include <vcl/vclenum.hxx>
41 #include <i18nlangtag/lang.h>
42 #include <o3tl/typed_flags_set.hxx>
43 #include <com/sun/star/uno/Reference.h>
44 
45 
46 class BitmapEx;
47 namespace weld
48 {
49  class Builder;
50  class MessageDialog;
51  class Widget;
52  class Window;
53 }
54 class LocaleDataWrapper;
55 class AllSettings;
56 class DataChangedEvent;
57 class Accelerator;
58 class Help;
59 class OutputDevice;
60 namespace vcl { class Window; }
61 namespace vcl { class KeyCode; }
62 class NotifyEvent;
63 class KeyEvent;
64 class MouseEvent;
65 class GestureEvent;
66 struct ImplSVEvent;
67 struct ConvertData;
68 
69 namespace com {
70 namespace sun {
71 namespace star {
72 namespace uno {
73  class XComponentContext;
74 }
75 namespace ui {
76  namespace dialogs {
77  class XFilePicker2;
78  class XFolderPicker2;
79  }
80 }
81 namespace awt {
82  class XToolkit;
83  class XDisplayConnection;
84  class XWindow;
85 }
86 } } }
87 
88 // helper needed by SalLayout implementations as well as svx/source/dialog/svxbmpnumbalueset.cxx
91 
92 enum class SystemWindowFlags {
93  NOAUTOMODE = 0x0001,
94  DIALOG = 0x0002
95 };
96 namespace o3tl
97 {
98  template<> struct typed_flags<SystemWindowFlags> : is_typed_flags<SystemWindowFlags, 0x03> {};
99 }
100 
101 typedef long (*VCLEventHookProc)( NotifyEvent& rEvt, void* pData );
102 
121 {
122 public:
123  enum class Type {
124  Accept,
125  Appear,
126  Open,
127  OpenHelpUrl,
128  Print,
129  PrivateDoShutdown,
130  QuickStart,
131  ShowDialog,
132  Unaccept
133  };
134 
142  explicit ApplicationEvent(Type type): aEvent(type)
143  {
144  assert(type == Type::Appear || type == Type::PrivateDoShutdown || type == Type::QuickStart);
145  }
146 
154  ApplicationEvent(Type type, OUString const & data): aEvent(type)
155  {
156  assert(
157  type == Type::Accept || type == Type::OpenHelpUrl
158  || type == Type::ShowDialog || type == Type::Unaccept);
159  aData.push_back(data);
160  }
161 
169  ApplicationEvent(Type type, std::vector<OUString> const & data):
170  aEvent(type), aData(data)
171  {
172  assert(type == Type::Open || type == Type::Print);
173  }
174 
179  Type GetEvent() const
180  {
181  return aEvent;
182  }
183 
191  OUString const & GetStringData() const
192  {
193  assert(
194  aEvent == Type::Accept
195  || aEvent == Type::OpenHelpUrl || aEvent == Type::ShowDialog
196  || aEvent == Type::Unaccept);
197  assert(aData.size() == 1);
198  return aData[0];
199  }
200 
206  std::vector<OUString> const & GetStringsData() const
207  {
208  assert(aEvent == Type::Open || aEvent == Type::Print);
209  return aData;
210  }
211 
212 private:
213  Type const aEvent;
214  std::vector<OUString> aData;
215 };
216 
217 enum class DialogCancelMode {
218  Off,
219  Silent,
220  Fatal
221 };
222 
238 {
239 public:
244 
254  Application();
255 
261  virtual ~Application();
262 
270  virtual void Init();
271 
276  virtual void InitFinished();
277 
285  virtual void DeInit();
286 
288 
349  virtual int Main();
350 
355  virtual bool QueryExit();
356 
361 
369  static void NotifyAllWindows( DataChangedEvent& rDCEvt );
370 
372 
380 
388  static sal_uInt16 GetCommandLineParamCount();
389 
398  static OUString GetCommandLineParam( sal_uInt16 nParam );
399 
406  static OUString GetAppFileName();
407 
409 
424  virtual void Exception( ExceptionCategory nCategory );
425 
436  static void Abort( const OUString& rErrorText );
437 
439 
445 
452  static void Execute();
453 
459  static void Quit();
460 
476  static bool Reschedule( bool bHandleAllCurrentEvents = false );
477 
486  static void Yield();
487 
493  static void EndYield();
494 
505  static comphelper::SolarMutex& GetSolarMutex();
506 
514  static bool IsMainThread();
515 
526  static sal_uInt32 ReleaseSolarMutex();
527 
536  static void AcquireSolarMutex( sal_uInt32 nCount );
537 
545  static bool IsInMain();
546 
553  static bool IsInExecute();
554 
561  static bool IsInModalMode();
562 
567  static sal_uInt16 GetDispatchLevel();
568 
578  static bool AnyInput( VclInputFlags nType = VCL_INPUT_ANY );
579 
586  static sal_uInt64 GetLastInputInterval();
587 
589 
590  /* Determines if the UI is captured.
591 
592  The UI is considered captured if a system dialog is open (e.g. printer setup),
593  a floating window, menu or toolbox dropdown is open, or a window has been
594  captured by the mouse.
595 
596  @returns true if UI is captured, false if not
597  */
598  static bool IsUICaptured();
599 
606 
622  virtual void OverrideSystemSettings( AllSettings& rSettings );
623 
631  static void MergeSystemSettings( AllSettings& rSettings );
632 
641  static void SetSettings( const AllSettings& rSettings );
642 
651  static const AllSettings& GetSettings();
652 
657  static const LocaleDataWrapper& GetAppLocaleDataWrapper();
658 
660 
666 
668 
677  static void AddEventListener( const Link<VclSimpleEvent&,void>& rEventListener );
678 
685  static void RemoveEventListener( const Link<VclSimpleEvent&,void>& rEventListener );
686 
695  static void AddKeyListener( const Link<VclWindowEvent&,bool>& rKeyListener );
696 
703  static void RemoveKeyListener( const Link<VclWindowEvent&,bool>& rKeyListener );
704 
712  static void ImplCallEventListenersApplicationDataChanged( void* pData );
713 
720  static void ImplCallEventListeners( VclSimpleEvent& rEvent );
721 
730  static bool HandleKey( VclEventId nEvent, vcl::Window *pWin, KeyEvent* pKeyEvent );
731 
740  static ImplSVEvent * PostKeyEvent( VclEventId nEvent, vcl::Window *pWin, KeyEvent const * pKeyEvent );
741 
748  static ImplSVEvent * PostMouseEvent( VclEventId nEvent, vcl::Window *pWin, MouseEvent const * pMouseEvent );
749 
750  static ImplSVEvent* PostGestureEvent(VclEventId nEvent, vcl::Window* pWin, GestureEvent const * pGestureEvent);
751 
759  static void RemoveMouseAndKeyEvents( vcl::Window *pWin );
760 
775  static ImplSVEvent * PostUserEvent( const Link<void*,void>& rLink, void* pCaller = nullptr,
776  bool bReferenceLink = false );
777 
782  static void RemoveUserEvent( ImplSVEvent * nUserEvent );
783 
784  /*** Get the DisplayConnection.
785 
786  It is a reference to XDisplayConnection, which allows toolkits to send display
787  events to the application.
788 
789  @returns UNO reference to an object that implements the css:awt:XDisplayConnection
790  interface.
791  */
792  static css::uno::Reference< css::awt::XDisplayConnection > GetDisplayConnection();
793 
800  virtual void AppEvent( const ApplicationEvent& rAppEvent );
801 
803 
808 
816  static vcl::Window* GetFocusWindow();
817 
825  static OutputDevice* GetDefaultDevice();
826 
834  static vcl::Window* GetFirstTopLevelWindow();
835 
843  static vcl::Window* GetNextTopLevelWindow( vcl::Window const * pWindow );
844 
853  static long GetTopWindowCount();
854 
867  static vcl::Window* GetTopWindow( long nIndex );
868 
879  static vcl::Window* GetActiveTopWindow();
880 
882 
889  static void SetAppName( const OUString& rUniqueName );
890 
891 
894 
900  static OUString GetAppName();
901 
905  static OUString GetHWOSConfInfo();
906 
914  static bool LoadBrandBitmap (const char* pName, BitmapEx &rBitmap);
915 
917 
920 
928  static void SetDisplayName( const OUString& rDisplayName );
929 
934  static OUString GetDisplayName();
935 
940  static OUString GetToolkitName();
941 
948  static unsigned int GetScreenCount();
949 
958  static tools::Rectangle GetScreenPosSizePixel( unsigned int nScreen );
959 
970  static bool IsUnifiedDisplay();
971 
982  SAL_DLLPRIVATE static unsigned int GetBestScreen( const tools::Rectangle& );
983 
994  static unsigned int GetDisplayBuiltInScreen();
995 
1003  static unsigned int GetDisplayExternalScreen();
1004 
1006 
1015 
1025  static bool InsertAccel( Accelerator* pAccel );
1026 
1033  static void RemoveAccel( Accelerator const * pAccel );
1034 
1041  static size_t GetReservedKeyCodeCount();
1042 
1051  static const vcl::KeyCode* GetReservedKeyCode( size_t i );
1052 
1054 
1060 
1068  static void SetHelp( Help* pHelp = nullptr );
1069 
1077  static Help* GetHelp();
1078 
1080 
1087 
1100  static vcl::Window* GetDefDialogParent();
1101 
1102 
1109  static DialogCancelMode GetDialogCancelMode();
1110 
1121  static void SetDialogCancelMode( DialogCancelMode mode );
1122 
1129  static bool IsDialogCancelEnabled();
1130 
1131 
1139  static void SetSystemWindowMode( SystemWindowFlags nMode );
1140 
1147  static SystemWindowFlags GetSystemWindowMode();
1148 
1150 
1158 
1166  static css::uno::Reference< css::awt::XToolkit > GetVCLToolkit();
1167 
1169 
1170 
1171  /*** @name Graphic Filters
1172  */
1174 
1181  static void SetFilterHdl( const Link<ConvertData&,bool>& rLink );
1182 
1184 
1192  static void EnableHeadlessMode( bool dialogsAreFatal );
1193 
1198  static bool IsHeadlessModeEnabled();
1199 
1204  static void EnableConsoleOnly();
1205 
1208  static void EnableBitmapRendering();
1209 
1214  static bool IsBitmapRendering();
1215 
1217 
1224  static void EnableEventTestingMode();
1225 
1230  static bool IsEventTestingModeEnabled();
1231 
1233  static void EnableSafeMode();
1234 
1236  static bool IsSafeModeEnabled();
1237 
1239 
1244  static const OUString& GetDesktopEnvironment();
1245 
1246  /*** @name Platform Functionality
1247  */
1249 
1263  static void AddToRecentDocumentList(const OUString& rFileUrl, const OUString& rMimeType, const OUString& rDocumentService);
1264 
1265  /*** Show a native error messagebox
1266 
1267  @param sTitle Title of error messagebox
1268 
1269  @param sMessage Message displayed in messagebox
1270  */
1271  static void ShowNativeErrorBox(const OUString& sTitle ,
1272  const OUString& sMessage);
1273 
1275  static void UpdateMainThread();
1276 
1281  static bool hasNativeFileSelection();
1282 
1290  static css::uno::Reference< css::ui::dialogs::XFilePicker2 >
1291  createFilePicker( const css::uno::Reference< css::uno::XComponentContext >& rServiceManager );
1292 
1300  static css::uno::Reference< css::ui::dialogs::XFolderPicker2 >
1301  createFolderPicker( const css::uno::Reference< css::uno::XComponentContext >& rServiceManager );
1302 
1305  static void EndAllDialogs();
1306 
1309  static void EndAllPopups();
1310 
1312 
1322  static void LockFontUpdates(bool bLock);
1323 
1324  // For vclbootstrapprotector:
1325  static void setDeInitHook(Link<LinkParamNone*,void> const & hook);
1326 
1327  static weld::Builder* CreateBuilder(weld::Widget* pParent, const OUString &rUIFile);
1328  static weld::Builder* CreateInterimBuilder(vcl::Window* pParent, const OUString &rUIFile); //for the duration of vcl parent windows
1329 
1330  static weld::MessageDialog* CreateMessageDialog(weld::Widget* pParent, VclMessageType eMessageType,
1331  VclButtonsType eButtonType, const OUString& rPrimaryMessage);
1332 
1333  static weld::Window* GetFrameWeld(const css::uno::Reference<css::awt::XWindow>& rWindow);
1334 private:
1335  DECL_STATIC_LINK( Application, PostEventHandler, void*, void );
1336 };
1337 
1339  : public osl::Guard<comphelper::SolarMutex>
1340 {
1341 public:
1343  : osl::Guard<comphelper::SolarMutex>( Application::GetSolarMutex() ) {}
1344 };
1345 
1347  : public osl::ClearableGuard<comphelper::SolarMutex>
1348 {
1349 public:
1351  : osl::ClearableGuard<comphelper::SolarMutex>( Application::GetSolarMutex() ) {}
1352 };
1353 
1355  : public osl::ResettableGuard<comphelper::SolarMutex>
1356 {
1357 public:
1359  : osl::ResettableGuard<comphelper::SolarMutex>( Application::GetSolarMutex() ) {}
1360 };
1361 
1362 namespace vcl
1363 {
1364 
1368 {
1369 private:
1371 #ifdef DBG_UTIL
1373 #endif
1375 
1378 
1379 public:
1380 
1382  : m_isAcquired(false)
1383 #ifdef DBG_UTIL
1384  , m_isChecked(false)
1385 #endif
1386  , m_rSolarMutex(Application::GetSolarMutex())
1387 
1388  {
1389  m_isAcquired = m_rSolarMutex.tryToAcquire();
1390  }
1391 
1393  {
1394 #ifdef DBG_UTIL
1395  assert(m_isChecked);
1396 #endif
1397  if (m_isAcquired)
1398  m_rSolarMutex.release();
1399  }
1400 
1401  bool isAcquired()
1402  {
1403 #ifdef DBG_UTIL
1404  m_isChecked = true;
1405 #endif
1406  return m_isAcquired;
1407  }
1408 };
1409 
1410 } // namespace vcl
1411 
1417 {
1418  const sal_uInt32 mnReleased;
1419 public:
1420  SolarMutexReleaser(): mnReleased(Application::ReleaseSolarMutex()) {}
1422 };
1423 
1425 
1426 // returns true if vcl is already initialized
1427 VCL_DLLPUBLIC bool IsVCLInit();
1428 // returns true if vcl successfully initializes or was already initialized
1429 VCL_DLLPUBLIC bool InitVCL();
1430 VCL_DLLPUBLIC void DeInitVCL();
1431 
1433 
1434 // only allowed to call, if no thread is running. You must call JoinMainLoopThread to free all memory.
1435 VCL_DLLPUBLIC void CreateMainLoopThread( oslWorkerFunction pWorker, void * pThreadData );
1437 
1439 struct ImplSVHelpData;
1443 
1445 struct ImplSVWinData;
1449 
1451 {
1453 }
1454 
1455 #endif // _APP_HXX
1456 
1457 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
std::vector< OUString > const & GetStringsData() const
Gets the event's array of strings.
Definition: svapp.hxx:206
Type GetEvent() const
Get the type of event.
Definition: svapp.hxx:179
def Print(s)
OUString sMessage
sal_Int32 nIndex
ApplicationEvent(Type type, OUString const &data)
Constructor for ApplicationEvent, accepts a string for the data associated with the event...
Definition: svapp.hxx:154
VCL_DLLPUBLIC bool IsVCLInit()
Definition: svmain.cxx:271
static void AcquireSolarMutex(sal_uInt32 nCount)
Acquire Solar Mutex(es) for this thread.
Definition: svapp.cxx:541
void Init()
const char aData[]
VclButtonsType
Definition: vclenum.hxx:243
std::unique_ptr< ContentProperties > pData
Definition: help.hxx:60
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
VCL_DLLPUBLIC bool InitAccessBridge()
Definition: svapp.cxx:1583
VCL_DLLPUBLIC void SetSVHelpData(ImplSVHelpData *)
Definition: svdata.cxx:449
std::vector< OUString > aData
Definition: svapp.hxx:214
VCL_DLLPUBLIC void JoinMainLoopThread()
Definition: svmain.cxx:667
static ImplSVEvent * PostUserEvent(const Link< void *, void > &rLink, void *pCaller=nullptr, bool bReferenceLink=false)
Post a user event to the default window.
Definition: svapp.cxx:998
An application can be notified of a number of different events:
Definition: svapp.hxx:120
VCL_DLLPUBLIC void DestroySVHelpData(ImplSVHelpData *)
Definition: svdata.cxx:431
VclInputFlags
Definition: inputtypes.hxx:25
ApplicationEvent(Type type)
Explicit constructor for ApplicationEvent.
Definition: svapp.hxx:142
A helper class that calls Application::ReleaseSolarMutex() in its constructor and restores the mutex ...
Definition: svapp.hxx:1416
int nCount
VclEventId
Definition: vclevent.hxx:41
VclMessageType
Definition: vclenum.hxx:253
VCL_DLLPUBLIC void DestroySVWinData(ImplSVWinData *)
Definition: svdata.cxx:377
ExceptionCategory
sal_uInt32 release(bool bUnlockAll=false)
ApplicationEvent(Type type, std::vector< OUString > const &data)
Constructor for ApplicationEvent, accepts an array of strings for the data associated with the event...
Definition: svapp.hxx:169
VCL_DLLPUBLIC bool InitVCL()
Definition: svmain.cxx:290
const sal_uInt32 mnReleased
Definition: svapp.hxx:1418
sal_uInt16 char * pName
SolarMutexTryAndBuyGuard & operator=(const SolarMutexTryAndBuyGuard &)=delete
VCL_DLLPUBLIC Application * GetpApp()
Definition: svapp.cxx:148
silently cancel any dialogs
VCL_DLLPUBLIC ImplSVHelpData * CreateSVHelpData()
Definition: svdata.cxx:412
SystemWindowFlags
Definition: svapp.hxx:92
int i
QPRO_FUNC_TYPE const nType
sal_uInt16 & nParam
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:304
VCL_DLLPUBLIC void SetSVWinData(ImplSVWinData *)
Definition: svdata.cxx:382
VCL_DLLPUBLIC sal_UCS4 GetMirroredChar(sal_UCS4)
Definition: sallayout.cxx:131
Base class used mainly for the LibreOffice Desktop class.
Definition: svapp.hxx:237
VCL_DLLPUBLIC ImplSVWinData * CreateSVWinData()
Definition: svdata.cxx:363
ConversionMode mode
#define VCL_INPUT_ANY
Definition: inputtypes.hxx:39
VCL_DLLPUBLIC void CreateMainLoopThread(oslWorkerFunction pWorker, void *pThreadData)
Definition: svmain.cxx:649
VCL_DLLPUBLIC sal_UCS4 GetLocalizedChar(sal_UCS4, LanguageType)
Definition: sallayout.cxx:137
Type const aEvent
Definition: svapp.hxx:213
long(* VCLEventHookProc)(NotifyEvent &rEvt, void *pData)
Definition: svapp.hxx:101
cancel any dialogs by std::abort
virtual bool tryToAcquire()
sal_uInt32 sal_UCS4
Definition: fontcharmap.hxx:29
VCL_DLLPUBLIC void DeInitVCL()
Definition: svmain.cxx:412
guard class that uses tryToAcquire() and has isAcquired() to check
Definition: svapp.hxx:1367
OUString const & GetStringData() const
Gets the application event's data string.
Definition: svapp.hxx:191
DialogCancelMode
Definition: svapp.hxx:217
comphelper::SolarMutex & m_rSolarMutex
Definition: svapp.hxx:1374
weld::Window * GetFrameWeld(const SfxFrame *pFrame)
AnyEventRef aEvent
static void EndYield()
Definition: svapp.hxx:1450