Move SetDefaultTimeout to wxProtocol and set it to 60 seconds for both wxHTTP and...

[wxWidgets.git] / interface / wx / app.h

diff --git a/interface/wx/app.h b/interface/wx/app.h
index 595fe78aab983362964ae685b9384381971fc947..307a697bc71a8387913f7de4c34bff04affb93e3 100644 (file)
--- a/interface/wx/app.h
+++ b/interface/wx/app.h
@@ -11,14 +11,31 @@
     @class wxAppConsole
 
     This class is essential for writing console-only or hybrid apps without
     @class wxAppConsole
 
     This class is essential for writing console-only or hybrid apps without

-    having to define wxUSE_GUI=0.
+    having to define @c wxUSE_GUI=0.
+
+    It is used to:
+    @li set and get application-wide properties (see wxAppConsole::CreateTraits
+        and wxAppConsole::SetXXX functions)
+    @li implement the windowing system message or event loop: events in fact are
+        supported even in console-mode applications (see wxAppConsole::HandleEvent
+        and wxAppConsole::ProcessPendingEvents);
+    @li initiate application processing via wxApp::OnInit;
+    @li allow default processing of events not handled by other
+        objects in the application (see wxAppConsole::FilterEvent)
+    @li implement Apple-specific event handlers (see wxAppConsole::MacXXX functions)
+
+    You should use the macro IMPLEMENT_APP(appClass) in your application
+    implementation file to tell wxWidgets how to create an instance of your
+    application class.

 
 

-    @todo MORE INFO
+    Use DECLARE_APP(appClass) in a header file if you want the ::wxGetApp() function
+    (which returns a reference to your application object) to be visible to other
+    files.

 
     @library{wxbase}
     @category{appmanagement}
 
 
     @library{wxbase}
     @category{appmanagement}
 

-    @see @ref overview_app
+    @see @ref overview_app, wxApp, wxAppTraits, wxEventLoopBase

 */
 class wxAppConsole : public wxEvtHandler
 {
 */
 class wxAppConsole : public wxEvtHandler
 {


@@ -159,6 +176,20 @@ public:
     */
     static bool IsMainLoopRunning();
 
     */
     static bool IsMainLoopRunning();
 

+    /**
+        Returns @true if called from inside Yield().
+    */
+    bool IsYielding() const;
+
+    /**
+        Process all pending events; it is necessary to call this function to
+        process posted events.
+
+        This happens during each event loop iteration in GUI mode but if there is
+        no main loop, it may be also called directly.
+    */
+    virtual void ProcessPendingEvents();
+

     /**
         Called in response of an "open-application" Apple event.
         Override this to create a new document in your app.
     /**
         Called in response of an "open-application" Apple event.
         Override this to create a new document in your app.


@@ -440,6 +471,7 @@ public:
         user to perform actions which are not compatible with the current task.
         Disabling menu items or whole menus during processing can avoid unwanted
         reentrance of code: see ::wxSafeYield for a better function.
         user to perform actions which are not compatible with the current task.
         Disabling menu items or whole menus during processing can avoid unwanted
         reentrance of code: see ::wxSafeYield for a better function.

+        You can avoid unwanted reentrancies also using IsYielding().

 
         Note that Yield() will not flush the message logs. This is intentional as
         calling Yield() is usually done to quickly update the screen and popping up
 
         Note that Yield() will not flush the message logs. This is intentional as
         calling Yield() is usually done to quickly update the screen and popping up


@@ -478,26 +510,19 @@ public:
 /**
     @class wxApp
 
 /**
     @class wxApp
 

-    The wxApp class represents the application itself. It is used to:
-
-    @li set and get application-wide properties;
-    @li implement the windowing system message or event loop;
-    @li initiate application processing via wxApp::OnInit;
-    @li allow default processing of events not handled by other
-        objects in the application.
+    The wxApp class represents the application itself when @c wxUSE_GUI=1.

 
 

-    You should use the macro IMPLEMENT_APP(appClass) in your application
-    implementation file to tell wxWidgets how to create an instance of your
-    application class.
+    In addition to the features provided by wxAppConsole it keeps track of
+    the <em>top window</em> (see SetTopWindow()) and adds support for
+    video modes (see SetVideoMode()).

 
 

-    Use DECLARE_APP(appClass) in a header file if you want the wxGetApp function
-    (which returns a reference to your application object) to be visible to other
-    files.
+    In general, application-wide settings for GUI-only apps are accessible
+    from wxApp (or from wxSystemSettings or wxSystemOptions classes).

 
     @library{wxbase}
     @category{appmanagement}
 
 
     @library{wxbase}
     @category{appmanagement}
 

-    @see @ref overview_app
+    @see @ref overview_app, wxAppTraits, wxEventLoopBase, wxSystemSettings

 */
 class wxApp : public wxAppConsole
 {
 */
 class wxApp : public wxAppConsole
 {


@@ -513,6 +538,12 @@ public:
     */
     virtual ~wxApp();
 
     */
     virtual ~wxApp();
 

+    /**
+        Get display mode that is used use. This is only used in framebuffer
+        wxWin ports (such as wxMGL or wxDFB).
+    */
+    virtual wxVideoMode GetDisplayMode() const;
+

     /**
         Returns @true if the application will exit when the top-level frame is deleted.
 
     /**
         Returns @true if the application will exit when the top-level frame is deleted.
 


@@ -520,6 +551,12 @@ public:
     */
     bool GetExitOnFrameDelete() const;
 
     */
     bool GetExitOnFrameDelete() const;
 

+    /**
+        Return the layout direction for the current locale or @c wxLayout_Default
+        if it's unknown.
+    */
+    virtual wxLayoutDirection GetLayoutDirection() const;
+

     /**
         Returns @true if the application will use the best visual on systems that support
         different visuals, @false otherwise.
     /**
         Returns @true if the application will use the best visual on systems that support
         different visuals, @false otherwise.


@@ -587,6 +624,13 @@ public:
     */
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 
     */
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 

+    /**
+        Set display mode to use. This is only used in framebuffer wxWin
+        ports (such as wxMGL or wxDFB). This method should be called from
+        wxApp::OnInitGui.
+    */
+    virtual bool SetDisplayMode(const wxVideoMode& info);
+

     /**
         Allows the programmer to specify whether the application will exit when the
         top-level frame is deleted.
     /**
         Allows the programmer to specify whether the application will exit when the
         top-level frame is deleted.


@@ -666,11 +710,11 @@ public:
 // ============================================================================
 
 
 // ============================================================================
 
 

-/** @ingroup group_funcmacro_rtti */
+/** @addtogroup group_funcmacro_rtti */

 //@{
 
 /**
 //@{
 
 /**

-    This is used in headers to create a forward declaration of the wxGetApp()
+    This is used in headers to create a forward declaration of the ::wxGetApp()

     function implemented by IMPLEMENT_APP().
 
     It creates the declaration <tt>className& wxGetApp()</tt>.
     function implemented by IMPLEMENT_APP().
 
     It creates the declaration <tt>className& wxGetApp()</tt>.


@@ -714,7 +758,7 @@ wxApp *wxTheApp;
 
 
 
 
 
 

-/** @ingroup group_funcmacro_appinitterm */
+/** @addtogroup group_funcmacro_appinitterm */

 //@{
 
 /**
 //@{
 
 /**


@@ -800,9 +844,9 @@ void wxWakeUpIdle();
 bool wxYield();
 
 /**
 bool wxYield();
 
 /**

-    This function is similar to wxYield, except that it disables the user input to
-    all program windows before calling wxYield and re-enables it again
-    afterwards. If @a win is not @NULL, this window will remain enabled,
+    This function is similar to wxYield(), except that it disables the user
+    input to all program windows before calling wxYield() and re-enables it
+    again afterwards. If @a win is not @NULL, this window will remain enabled,

     allowing the implementation of some limited user interaction.
     Returns the result of the call to ::wxYield.
 
     allowing the implementation of some limited user interaction.
     Returns the result of the call to ::wxYield.
 


@@ -856,7 +900,7 @@ int wxEntry(HINSTANCE hInstance,
 
 
 
 
 
 

-/** @ingroup group_funcmacro_procctrl */
+/** @addtogroup group_funcmacro_procctrl */

 //@{
 
 /**
 //@{
 
 /**