]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/app.h
Move code removing "-psn_xxx" command line arguments to common code.
[wxWidgets.git] / interface / wx / app.h
index c17ad1c002b1e1be86fda0ef4e2c6171a96eab94..e72c65f74873602cba2acf126840fa1015ea710b 100644 (file)
@@ -2,7 +2,6 @@
 // Name:        app.h
 // Purpose:     interface of wxApp
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -37,7 +36,8 @@
 
     @see @ref overview_app, wxApp, wxAppTraits, wxEventLoopBase
 */
-class wxAppConsole : public wxEvtHandler
+class wxAppConsole : public wxEvtHandler,
+                     public wxEventFilter
 {
 protected:
     /**
@@ -81,18 +81,19 @@ public:
     virtual void ExitMainLoop();
 
     /**
+        Overridden wxEventFilter method.
+
         This function is called before processing any event and allows the application
-        to preempt the processing of some events.
+        to preempt the processing of some events, see wxEventFilter
+        documentation for more information.
 
-        If this method returns -1 the event is processed normally, otherwise either
-        @true or @false should be returned and the event processing stops immediately
-        considering that the event had been already processed (for the former return
-        value) or that it is not going to be processed at all (for the latter one).
+        wxApp implementation of this method always return -1 indicating that
+        the event should be processed normally.
     */
     virtual int FilterEvent(wxEvent& event);
 
     /**
-        Returns the main event loop instance, i.e. the event loop which is started
+        Returns the main event loop instance, i.e.\ the event loop which is started
         by OnRun() and which dispatches all events sent from the native toolkit
         to the application (except when new event loops are temporarily set-up).
         The returned value maybe @NULL. Put initialization code which needs a
@@ -243,7 +244,7 @@ public:
     static wxAppConsole* GetInstance();
 
     /**
-        Returns @true if the main event loop is currently running, i.e. if the
+        Returns @true if the main event loop is currently running, i.e.\ if the
         application is inside OnRun().
 
         This can be useful to test whether events can be dispatched. For example,
@@ -258,7 +259,7 @@ public:
     //@{
 
     /**
-        This function is called when an assert failure occurs, i.e. the condition
+        This function is called when an assert failure occurs, i.e.\ the condition
         specified in wxASSERT() macro evaluated to @false.
 
         It is only called in debug mode (when @c __WXDEBUG__ is defined) as
@@ -286,7 +287,7 @@ public:
                                  const wxChar *msg);
 
     /**
-        Called when command line parsing fails (i.e. an incorrect command line option
+        Called when command line parsing fails (i.e.\ an incorrect command line option
         was specified by the user). The default behaviour is to show the program usage
         text and abort the program.
 
@@ -559,6 +560,33 @@ public:
 
     //@}
 
+    /**
+        Sets the C locale to the default locale for the current environment.
+
+        It is advised to call this to ensure that the underlying toolkit uses
+        the locale in which the numbers and monetary amounts are shown in the
+        format expected by user and so on.
+
+        Calling this function is roughly equivalent to calling
+        @code
+            setlocale(LC_ALL, "");
+        @endcode
+        but performs additional toolkit-specific tasks under some platforms and
+        so should be used instead of @c setlocale() itself. Alternatively, you
+        can use wxLocale to change the locale with more control.
+
+        Notice that this does @em not change the global C++ locale, you need to
+        do it explicitly if you want, e.g.
+        @code
+            std::locale::global(std::locale(""));
+        @endcode
+        but be warned that locale support in C++ standard library can be poor
+        or worse under some platforms, e.g. the above line results in an
+        immediate crash under OS X up to the version 10.8.2.
+
+        @since 2.9.5
+     */
+    void SetCLocale();
 
     /**
         Number of command line arguments (after environment-specific processing).
@@ -633,7 +661,7 @@ public:
 
     /**
         Get display mode that is used use. This is only used in framebuffer
-        wxWidgets ports (such as wxMGL or wxDFB).
+        wxWidgets ports such as wxDFB.
     */
     virtual wxVideoMode GetDisplayMode() const;
 
@@ -671,7 +699,7 @@ public:
     virtual wxWindow* GetTopWindow() const;
 
     /**
-        Returns @true if the application is active, i.e. if one of its windows is
+        Returns @true if the application is active, i.e.\ if one of its windows is
         currently in the foreground.
 
         If this function returns @false and you need to attract users attention to
@@ -725,7 +753,7 @@ public:
 
     /**
         Set display mode to use. This is only used in framebuffer wxWidgets
-        ports (such as wxMGL or wxDFB).
+        ports such as wxDFB.
     */
     virtual bool SetDisplayMode(const wxVideoMode& info);
 
@@ -852,17 +880,6 @@ public:
     */
     virtual void MacReopenApp();
 
-
-    static long GetMacAboutMenuItemId();
-    static long GetMacPreferencesMenuItemId();
-    static long GetMacExitMenuItemId();
-    static wxString GetMacHelpMenuTitleName();
-
-    static void SetMacAboutMenuItemId(long val);
-    static void SetMacPreferencesMenuItemId(long val);
-    static void SetMacExitMenuItemId(long val);
-    static void SetMacHelpMenuTitleName(const wxString& val);
-
     //@}
 
 };