Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/app.h b/include/wx/app.h
index 5e0e97060ed65b27896dfc14ca060c2787f5e09a..a0fe4afee1771d01b62172d75580a0792ea14931 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -18,16 +18,17 @@
 // ----------------------------------------------------------------------------
 
 #include "wx/event.h"       // for the base class
 // ----------------------------------------------------------------------------
 
 #include "wx/event.h"       // for the base class

+#include "wx/eventfilter.h" // (and another one)

 #include "wx/build.h"
 #include "wx/cmdargs.h"     // for wxCmdLineArgsArray used by wxApp::argv
 #include "wx/init.h"        // we must declare wxEntry()
 #include "wx/intl.h"        // for wxLayoutDirection
 #include "wx/build.h"
 #include "wx/cmdargs.h"     // for wxCmdLineArgsArray used by wxApp::argv
 #include "wx/init.h"        // we must declare wxEntry()
 #include "wx/intl.h"        // for wxLayoutDirection

+#include "wx/log.h"         // for wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD()

 
 class WXDLLIMPEXP_FWD_BASE wxAppConsole;
 class WXDLLIMPEXP_FWD_BASE wxAppTraits;
 class WXDLLIMPEXP_FWD_BASE wxCmdLineParser;
 class WXDLLIMPEXP_FWD_BASE wxEventLoopBase;
 
 class WXDLLIMPEXP_FWD_BASE wxAppConsole;
 class WXDLLIMPEXP_FWD_BASE wxAppTraits;
 class WXDLLIMPEXP_FWD_BASE wxCmdLineParser;
 class WXDLLIMPEXP_FWD_BASE wxEventLoopBase;

-class WXDLLIMPEXP_FWD_BASE wxLog;

 class WXDLLIMPEXP_FWD_BASE wxMessageOutput;
 
 #if wxUSE_GUI
 class WXDLLIMPEXP_FWD_BASE wxMessageOutput;
 
 #if wxUSE_GUI


@@ -35,6 +36,11 @@ class WXDLLIMPEXP_FWD_BASE wxMessageOutput;
     class WXDLLIMPEXP_FWD_CORE wxWindow;
 #endif
 
     class WXDLLIMPEXP_FWD_CORE wxWindow;
 #endif
 

+// this macro should be used in any main() or equivalent functions defined in wx
+#define wxDISABLE_DEBUG_SUPPORT() \
+    wxDISABLE_ASSERTS_IN_RELEASE_BUILD(); \
+    wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD()
+

 // ----------------------------------------------------------------------------
 // typedefs
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // typedefs
 // ----------------------------------------------------------------------------


@@ -52,11 +58,21 @@ enum
     wxPRINT_POSTSCRIPT = 2
 };
 
     wxPRINT_POSTSCRIPT = 2
 };
 

+// ----------------------------------------------------------------------------
+// global variables
+// ----------------------------------------------------------------------------
+
+// use of this list is strongly deprecated, use wxApp ScheduleForDestruction()
+// and IsScheduledForDestruction()  methods instead of this list directly, it
+// is here for compatibility purposes only
+extern WXDLLIMPEXP_DATA_BASE(wxList) wxPendingDelete;
+

 // ----------------------------------------------------------------------------
 // wxAppConsoleBase: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxAppConsoleBase: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxAppConsoleBase : public wxEvtHandler
+class WXDLLIMPEXP_BASE wxAppConsoleBase : public wxEvtHandler,
+                                          public wxEventFilter

 {
 public:
     // ctor and dtor
 {
 public:
     // ctor and dtor


@@ -127,22 +143,17 @@ public:
     //     be argv[0]
 
         // set/get the application name
     //     be argv[0]
 
         // set/get the application name

-    wxString GetAppName() const
-    {
-        return m_appName.empty() ? m_className : m_appName;
-    }
+    wxString GetAppName() const;

     void SetAppName(const wxString& name) { m_appName = name; }
 
         // set/get the application display name: the display name is the name
         // shown to the user in titles, reports, etc while the app name is
         // used for paths, config, and other places the user doesn't see
         //
     void SetAppName(const wxString& name) { m_appName = name; }
 
         // set/get the application display name: the display name is the name
         // shown to the user in titles, reports, etc while the app name is
         // used for paths, config, and other places the user doesn't see
         //

-        // so the app name could be myapp while display name could be "My App"
-    wxString GetAppDisplayName() const
-    {
-        return m_appDisplayName.empty() ? GetAppName().Capitalize()
-                                        : m_appDisplayName;
-    }
+        // by default the display name is the same as app name or a capitalized
+        // version of the program if app name was not set neither but it's
+        // usually better to set it explicitly to something nicer
+    wxString GetAppDisplayName() const;

 
     void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; }
 
 
     void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; }
 


@@ -225,17 +236,24 @@ public:
     wxEventLoopBase* GetMainLoop() const
         { return m_mainLoop; }
 
     wxEventLoopBase* GetMainLoop() const
         { return m_mainLoop; }
 

+    // This function 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.
+    //
+    // Notice that this does _not_ change the global C++ locale, you need to do
+    // it explicitly if you want.
+    //
+    // Finally, notice that while this function is virtual, it is not supposed
+    // to be overridden outside of the library itself.
+    virtual void SetCLocale();
+

 
     // event processing functions
     // --------------------------
 
 
     // event processing functions
     // --------------------------
 

-    // this method allows to filter all the events processed by the program, so
-    // you should try to return quickly from it to avoid slowing down the
-    // program to the crawl
-    //
-    // return value should be -1 to continue with the normal event processing,
-    // or TRUE or FALSE to stop further processing and pretend that the event
-    // had been already processed or won't be processed at all, respectively
+    // Implement the inherited wxEventFilter method but just return -1 from it
+    // to indicate that default processing should take place.

     virtual int FilterEvent(wxEvent& event);
 
     // return true if we're running event loop, i.e. if the events can
     virtual int FilterEvent(wxEvent& event);
 
     // return true if we're running event loop, i.e. if the events can


@@ -317,9 +335,30 @@ public:
     void DeletePendingEvents();
 
 
     void DeletePendingEvents();
 
 

-    // wxEventLoop redirections
-    // ------------------------
+    // delayed destruction
+    // -------------------
+
+    // If an object may have pending events for it, it shouldn't be deleted
+    // immediately as this would result in a crash when trying to handle these
+    // events: instead, it should be scheduled for destruction and really
+    // destroyed only after processing all pending events.
+    //
+    // Notice that this is only possible if we have a running event loop,
+    // otherwise the object is just deleted directly by ScheduleForDestruction()
+    // and IsScheduledForDestruction() always returns false.
+
+    // schedule the object for destruction in the near future
+    void ScheduleForDestruction(wxObject *object);
+
+    // return true if the object is scheduled for destruction
+    bool IsScheduledForDestruction(wxObject *object) const;
+

 
 

+    // wxEventLoop-related methods
+    // ---------------------------
+
+    // all these functions are forwarded to the corresponding methods of the
+    // currently active event loop -- and do nothing if there is none

     virtual bool Pending();
     virtual bool Dispatch();
 
     virtual bool Pending();
     virtual bool Dispatch();
 


@@ -329,13 +368,25 @@ public:
     bool Yield(bool onlyIfNeeded = false);
 
     virtual void WakeUpIdle();
     bool Yield(bool onlyIfNeeded = false);
 
     virtual void WakeUpIdle();

+
+    // this method is called by the active event loop when there are no events
+    // to process
+    //
+    // by default it generates the idle events and if you override it in your
+    // derived class you should call the base class version to ensure that idle
+    // events are still sent out

     virtual bool ProcessIdle();
 
     virtual bool ProcessIdle();
 

+    // this virtual function is overridden in GUI wxApp to always return true
+    // as GUI applications always have an event loop -- but console ones may
+    // have it or not, so it simply returns true if already have an event loop
+    // running but false otherwise
+    virtual bool UsesEventLoop() const;
+

 
     // debugging support
     // -----------------
 
 
     // debugging support
     // -----------------
 

-#ifdef __WXDEBUG__

     // this function is called when an assert failure occurs, the base class
     // version does the normal processing (i.e. shows the usual assert failure
     // dialog box)
     // this function is called when an assert failure occurs, the base class
     // version does the normal processing (i.e. shows the usual assert failure
     // dialog box)


@@ -355,10 +406,9 @@ public:
                           int line,
                           const wxChar *cond,
                           const wxChar *msg);
                           int line,
                           const wxChar *cond,
                           const wxChar *msg);

-#endif // __WXDEBUG__

 
     // check that the wxBuildOptions object (constructed in the application
 
     // check that the wxBuildOptions object (constructed in the application

-    // itself, usually the one from IMPLEMENT_APP() macro) matches the build
+    // itself, usually the one from wxIMPLEMENT_APP() macro) matches the build

     // options of the library and abort if it doesn't
     static bool CheckBuildOptions(const char *optionsSignature,
                                   const char *componentName);
     // options of the library and abort if it doesn't
     static bool CheckBuildOptions(const char *optionsSignature,
                                   const char *componentName);


@@ -394,6 +444,11 @@ public:
 #endif
 
 protected:
 #endif
 
 protected:

+    // delete all objects in wxPendingDelete list
+    //
+    // called from ProcessPendingEvents()
+    void DeletePendingObjects();
+

     // the function which creates the traits object when GetTraits() needs it
     // for the first time
     virtual wxAppTraits *CreateTraits();
     // the function which creates the traits object when GetTraits() needs it
     // for the first time
     virtual wxAppTraits *CreateTraits();


@@ -451,7 +506,7 @@ protected:
     wxDECLARE_NO_COPY_CLASS(wxAppConsoleBase);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxAppConsoleBase);
 };
 

-#if defined(__UNIX__)
+#if defined(__UNIX__) && !defined(__WXMSW__)

     #include "wx/unix/app.h"
 #else
     // this has to be a class and not a typedef as we forward declare it
     #include "wx/unix/app.h"
 #else
     // this has to be a class and not a typedef as we forward declare it


@@ -516,9 +571,8 @@ public:
         // it should return true if more idle events are needed, false if not
     virtual bool ProcessIdle();
 
         // it should return true if more idle events are needed, false if not
     virtual bool ProcessIdle();
 

-        // Send idle event to window and all subwindows
-        // Returns true if more idle time is requested.
-    virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
+        // override base class version: GUI apps always use an event loop
+    virtual bool UsesEventLoop() const { return true; }

 
 
     // top level window functions
 
 
     // top level window functions


@@ -550,10 +604,10 @@ public:
     // ------------------------------------------------------------------------
 
         // Get display mode that is used use. This is only used in framebuffer
     // ------------------------------------------------------------------------
 
         // Get display mode that is used use. This is only used in framebuffer

-        // wxWin ports (such as wxMGL or wxDFB).
+        // wxWin ports such as wxDFB.

     virtual wxVideoMode GetDisplayMode() const;
         // Set display mode to use. This is only used in framebuffer wxWin
     virtual wxVideoMode GetDisplayMode() const;
         // Set display mode to use. This is only used in framebuffer wxWin

-        // ports (such as wxMGL or wxDFB). This method should be called from
+        // ports such as wxDFB. This method should be called from

         // wxApp::OnInitGui
     virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
 
         // wxApp::OnInitGui
     virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
 


@@ -601,9 +655,6 @@ public:
 #endif // WXWIN_COMPATIBILITY_2_6
 
 protected:
 #endif // WXWIN_COMPATIBILITY_2_6
 
 protected:

-    // delete all objects in wxPendingDelete list
-    void DeletePendingObjects();
-

     // override base class method to use GUI traits
     virtual wxAppTraits *CreateTraits();
 
     // override base class method to use GUI traits
     virtual wxAppTraits *CreateTraits();
 


@@ -642,14 +693,10 @@ protected:
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 

-#if defined(__WXPALMOS__)
-    #include "wx/palmos/app.h"
-#elif defined(__WXMSW__)
+#if defined(__WXMSW__)

     #include "wx/msw/app.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/app.h"
     #include "wx/msw/app.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/app.h"

-#elif defined(__WXMGL__)
-    #include "wx/mgl/app.h"

 #elif defined(__WXDFB__)
     #include "wx/dfb/app.h"
 #elif defined(__WXGTK20__)
 #elif defined(__WXDFB__)
     #include "wx/dfb/app.h"
 #elif defined(__WXGTK20__)


@@ -682,7 +729,7 @@ protected:
 // object of type wxApp
 //
 // note that instead of using of wxTheApp in application code you should
 // object of type wxApp
 //
 // note that instead of using of wxTheApp in application code you should

-// consider using DECLARE_APP() after which you may call wxGetApp() which will
+// consider using wxDECLARE_APP() after which you may call wxGetApp() which will

 // return the object of the correct type (i.e. MyApp and not wxApp)
 //
 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
 // return the object of the correct type (i.e. MyApp and not wxApp)
 //
 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in


@@ -727,34 +774,53 @@ public:
         { wxApp::SetInitializerFunction(fn); }
 };
 
         { wxApp::SetInitializerFunction(fn); }
 };
 

-// the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if
+// the code below defines a wxIMPLEMENT_WXWIN_MAIN macro which you can use if

 // your compiler really, really wants main() to be in your main program (e.g.
 // your compiler really, really wants main() to be in your main program (e.g.

-// hello.cpp). Now IMPLEMENT_APP should add this code if required.
-
-#define IMPLEMENT_WXWIN_MAIN_CONSOLE \
-        int main(int argc, char **argv) { return wxEntry(argc, argv); }
+// hello.cpp). Now wxIMPLEMENT_APP should add this code if required.
+
+// For compilers that support it, prefer to use wmain() as this ensures any
+// Unicode strings can be passed as command line parameters and not just those
+// representable in the current locale.
+#if wxUSE_UNICODE && defined(__VISUALC__)
+    #define wxIMPLEMENT_WXWIN_MAIN_CONSOLE                                    \
+        int wmain(int argc, wchar_t **argv)                                   \
+        {                                                                     \
+            wxDISABLE_DEBUG_SUPPORT();                                        \
+                                                                              \
+            return wxEntry(argc, argv);                                       \
+        }
+#else // Use standard main()
+    #define wxIMPLEMENT_WXWIN_MAIN_CONSOLE                                    \
+        int main(int argc, char **argv)                                       \
+        {                                                                     \
+            wxDISABLE_DEBUG_SUPPORT();                                        \
+                                                                              \
+            return wxEntry(argc, argv);                                       \
+        }
+#endif

 
 // port-specific header could have defined it already in some special way
 
 // port-specific header could have defined it already in some special way

-#ifndef IMPLEMENT_WXWIN_MAIN
-    #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
-#endif // defined(IMPLEMENT_WXWIN_MAIN)
+#ifndef wxIMPLEMENT_WXWIN_MAIN
+    #define wxIMPLEMENT_WXWIN_MAIN          wxIMPLEMENT_WXWIN_MAIN_CONSOLE
+#endif // defined(wxIMPLEMENT_WXWIN_MAIN)

 
 #ifdef __WXUNIVERSAL__
     #include "wx/univ/theme.h"
 
     #ifdef wxUNIV_DEFAULT_THEME
 
 #ifdef __WXUNIVERSAL__
     #include "wx/univ/theme.h"
 
     #ifdef wxUNIV_DEFAULT_THEME

-        #define IMPLEMENT_WX_THEME_SUPPORT \
+        #define wxIMPLEMENT_WX_THEME_SUPPORT \

             WX_USE_THEME(wxUNIV_DEFAULT_THEME);
     #else
             WX_USE_THEME(wxUNIV_DEFAULT_THEME);
     #else

-        #define IMPLEMENT_WX_THEME_SUPPORT
+        #define wxIMPLEMENT_WX_THEME_SUPPORT

     #endif
 #else
     #endif
 #else

-    #define IMPLEMENT_WX_THEME_SUPPORT
+    #define wxIMPLEMENT_WX_THEME_SUPPORT

 #endif
 
 // Use this macro if you want to define your own main() or WinMain() function
 // and call wxEntry() from there.
 #endif
 
 // Use this macro if you want to define your own main() or WinMain() function
 // and call wxEntry() from there.

-#define IMPLEMENT_APP_NO_MAIN(appname)                                      \
+#define wxIMPLEMENT_APP_NO_MAIN(appname)                                    \
+    appname& wxGetApp() { return *static_cast<appname*>(wxApp::GetInstance()); }    \

     wxAppConsole *wxCreateApp()                                             \
     {                                                                       \
         wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE,         \
     wxAppConsole *wxCreateApp()                                             \
     {                                                                       \
         wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE,         \


@@ -762,37 +828,53 @@ public:
         return new appname;                                                 \
     }                                                                       \
     wxAppInitializer                                                        \
         return new appname;                                                 \
     }                                                                       \
     wxAppInitializer                                                        \

-        wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp);        \
-    DECLARE_APP(appname)                                                    \
-    appname& wxGetApp() { return *static_cast<appname*>(wxApp::GetInstance()); }
+        wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp)

 
 

-// Same as IMPLEMENT_APP() normally but doesn't include themes support in
+// Same as wxIMPLEMENT_APP() normally but doesn't include themes support in

 // wxUniversal builds
 // wxUniversal builds

-#define IMPLEMENT_APP_NO_THEMES(appname)    \
-    IMPLEMENT_APP_NO_MAIN(appname)          \
-    IMPLEMENT_WXWIN_MAIN
+#define wxIMPLEMENT_APP_NO_THEMES(appname)  \
+    wxIMPLEMENT_WXWIN_MAIN                  \
+    wxIMPLEMENT_APP_NO_MAIN(appname)

 
 // Use this macro exactly once, the argument is the name of the wxApp-derived
 // class which is the class of your application.
 
 // Use this macro exactly once, the argument is the name of the wxApp-derived
 // class which is the class of your application.

-#define IMPLEMENT_APP(appname)              \
-    IMPLEMENT_APP_NO_THEMES(appname)        \
-    IMPLEMENT_WX_THEME_SUPPORT
+#define wxIMPLEMENT_APP(appname)            \
+    wxIMPLEMENT_WX_THEME_SUPPORT            \
+    wxIMPLEMENT_APP_NO_THEMES(appname)

 
 // Same as IMPLEMENT_APP(), but for console applications.
 
 // Same as IMPLEMENT_APP(), but for console applications.

-#define IMPLEMENT_APP_CONSOLE(appname)      \
-    IMPLEMENT_APP_NO_MAIN(appname)          \
-    IMPLEMENT_WXWIN_MAIN_CONSOLE
+#define wxIMPLEMENT_APP_CONSOLE(appname)    \
+    wxIMPLEMENT_WXWIN_MAIN_CONSOLE          \
+    wxIMPLEMENT_APP_NO_MAIN(appname)

 
 // this macro can be used multiple times and just allows you to use wxGetApp()
 // function
 
 // this macro can be used multiple times and just allows you to use wxGetApp()
 // function

-#define DECLARE_APP(appname) extern appname& wxGetApp();
+#define wxDECLARE_APP(appname)              \
+    extern appname& wxGetApp()

 
 
 
 

-// declare the stuff defined by IMPLEMENT_APP() macro, it's not really needed
+// declare the stuff defined by wxIMPLEMENT_APP() macro, it's not really needed

 // anywhere else but at the very least it suppresses icc warnings about
 // defining extern symbols without prior declaration, and it shouldn't do any
 // harm
 extern wxAppConsole *wxCreateApp();
 extern wxAppInitializer wxTheAppInitializer;
 
 // anywhere else but at the very least it suppresses icc warnings about
 // defining extern symbols without prior declaration, and it shouldn't do any
 // harm
 extern wxAppConsole *wxCreateApp();
 extern wxAppInitializer wxTheAppInitializer;
 

+// ----------------------------------------------------------------------------
+// Compatibility macro aliases
+// ----------------------------------------------------------------------------
+
+// deprecated variants _not_ requiring a semicolon after them
+// (note that also some wx-prefixed macro do _not_ require a semicolon because
+//  it's not always possible to force the compire to require it)
+
+#define IMPLEMENT_WXWIN_MAIN_CONSOLE            wxIMPLEMENT_WXWIN_MAIN_CONSOLE
+#define IMPLEMENT_WXWIN_MAIN                    wxIMPLEMENT_WXWIN_MAIN
+#define IMPLEMENT_WX_THEME_SUPPORT              wxIMPLEMENT_WX_THEME_SUPPORT
+#define IMPLEMENT_APP_NO_MAIN(app)              wxIMPLEMENT_APP_NO_MAIN(app);
+#define IMPLEMENT_APP_NO_THEMES(app)            wxIMPLEMENT_APP_NO_THEMES(app);
+#define IMPLEMENT_APP(app)                      wxIMPLEMENT_APP(app);
+#define IMPLEMENT_APP_CONSOLE(app)              wxIMPLEMENT_APP_CONSOLE(app);
+#define DECLARE_APP(app)                        wxDECLARE_APP(app);
+

 #endif // _WX_APP_H_BASE_
 #endif // _WX_APP_H_BASE_