Constructor. Called implicitly with a definition of a wxApp object.
-% VZ: there is no such feature so far...
-% The argument is a language identifier; this is an experimental
-% feature and will be expanded and documented in future versions.
-
\membersection{wxApp::\destruct{wxApp}}
\func{void}{\destruct{wxApp}}{\void}
\helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnChar}{wxwindowonchar},\rtfsp
\helpref{wxWindow::OnCharHook}{wxwindowoncharhook}, \helpref{wxDialog::OnCharHook}{wxdialogoncharhook}
-\membersection{wxApp::OnFatalException}\label{wxapponfatalexception}
+\membersection{wxApp::OnCmdLineError}\label{wxapponcmdlineerror}
-\func{void}{OnFatalException}{\void}
+\func{bool}{OnCmdLineError}{\param{wxCmdLineParser\& }{parser}}
-This function may be called if something fatal happens: an unhandled
-exception under Win32 or a a fatal signal under Unix, for example. However,
-this will not happen by default: you have to explicitly call
-\helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions} to enable this.
+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.
-Generally speaking, this function should only show a message to the user and
-return. You may attempt to save unsaved data but this is not guaranteed to
-work and, in fact, probably won't.
+Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return
+{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
\wxheading{See also}
-\helpref{wxHandleFatalExcetions}{wxhandlefatalexceptions}
+\helpref{OnInitCmdLine}{wxapponinitcmdline}
-\membersection{wxApp::OnIdle}\label{wxapponidle}
+\membersection{wxApp::OnCmdLineHelp}\label{wxapponcmdlinehelp}
-\func{void}{OnIdle}{\param{wxIdleEvent\& }{event}}
+\func{bool}{OnCmdLineHelp}{\param{wxCmdLineParser\& }{parser}}
-Override this member function for any processing which needs to be done
-when the application is idle. You should call wxApp::OnIdle from your own function,
-since this forwards OnIdle events to windows and also performs garbage collection for
-windows whose destruction has been delayed.
+Called when the help option ({\tt --help}) was specified on the command line.
+The default behaviour is to show the program usage text and abort the program.
-wxWindows' strategy for OnIdle processing is as follows. After pending user interface events for an
-application have all been processed, wxWindows sends an OnIdle event to the application object. wxApp::OnIdle itself
-sends an OnIdle event to each application window, allowing windows to do idle processing such as updating
-their appearance. If either wxApp::OnIdle or a window OnIdle function requested more time, by
-caling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
-event to the application object. This will occur in a loop until either a user event is found to be
-pending, or OnIdle requests no more time. Then all pending user events are processed until the system
-goes idle again, when OnIdle is called, and so on.
+Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return
+{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
\wxheading{See also}
-\helpref{wxWindow::OnIdle}{wxwindowonidle}, \helpref{wxIdleEvent}{wxidleevent},\rtfsp
-\helpref{wxWindow::SendIdleEvents}{wxappsendidleevents}
+\helpref{OnInitCmdLine}{wxapponinitcmdline}
-\membersection{wxApp::OnEndSession}\label{wxapponendsession}
+\membersection{wxApp::OnCmdLineParsed}\label{wxapponcmdlineparsed}
-\func{void}{OnEndSession}{\param{wxCloseEvent\& }{event}}
+\func{bool}{OnCmdLineParsed}{\param{wxCmdLineParser\& }{parser}}
-This is an event handler function called when the operating system or GUI session is
-about to close down. The application has a chance to silently save information,
-and can optionally close itself.
+Called after the command line had been successfully parsed. You may override
+this method to test for the values of the various parameters which could be
+set from the command line.
-Use the EVT\_END\_SESSION event table macro to handle query end session events.
+Don't forget to call the base class version unless you want to suppress
+processing of the standard command line options.
-The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a TRUE argument
-(forcing the application to close itself silently).
+Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return
+{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
-\wxheading{Remarks}
+\wxheading{See also}
-Under X, OnEndSession is called in response to the `die' event.
+\helpref{OnInitCmdLine}{wxapponinitcmdline}
-Under Windows, OnEndSession is called in response to the WM\_ENDSESSION message.
+\membersection{wxApp::OnFatalException}\label{wxapponfatalexception}
+
+\func{void}{OnFatalException}{\void}
+
+This function may be called if something fatal happens: an unhandled
+exception under Win32 or a a fatal signal under Unix, for example. However,
+this will not happen by default: you have to explicitly call
+\helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions} to enable this.
+
+Generally speaking, this function should only show a message to the user and
+return. You may attempt to save unsaved data but this is not guaranteed to
+work and, in fact, probably won't.
\wxheading{See also}
-\helpref{wxWindow::Close}{wxwindowclose},\rtfsp
-\helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
-\helpref{wxCloseEvent}{wxcloseevent},\rtfsp
-\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession}
+\helpref{wxHandleFatalExcetions}{wxhandlefatalexceptions}
+
+%% VZ: the wxApp event handler are private and should not be documented here!
+%%
+%%\membersection{wxApp::OnIdle}\label{wxapponidle}
+%%
+%%\func{void}{OnIdle}{\param{wxIdleEvent\& }{event}}
+%%
+%%Override this member function for any processing which needs to be done
+%%when the application is idle. You should call wxApp::OnIdle from your own function,
+%%since this forwards OnIdle events to windows and also performs garbage collection for
+%%windows whose destruction has been delayed.
+%%
+%%wxWindows' strategy for OnIdle processing is as follows. After pending user interface events for an
+%%application have all been processed, wxWindows sends an OnIdle event to the application object. wxApp::OnIdle itself
+%%sends an OnIdle event to each application window, allowing windows to do idle processing such as updating
+%%their appearance. If either wxApp::OnIdle or a window OnIdle function requested more time, by
+%%caling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
+%%event to the application object. This will occur in a loop until either a user event is found to be
+%%pending, or OnIdle requests no more time. Then all pending user events are processed until the system
+%%goes idle again, when OnIdle is called, and so on.
+%%
+%%\wxheading{See also}
+%%
+%%\helpref{wxWindow::OnIdle}{wxwindowonidle}, \helpref{wxIdleEvent}{wxidleevent},\rtfsp
+%%\helpref{wxWindow::SendIdleEvents}{wxappsendidleevents}
+%%
+%%\membersection{wxApp::OnEndSession}\label{wxapponendsession}
+%%
+%%\func{void}{OnEndSession}{\param{wxCloseEvent\& }{event}}
+%%
+%%This is an event handler function called when the operating system or GUI session is
+%%about to close down. The application has a chance to silently save information,
+%%and can optionally close itself.
+%%
+%%Use the EVT\_END\_SESSION event table macro to handle query end session events.
+%%
+%%The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a TRUE argument
+%%(forcing the application to close itself silently).
+%%
+%%\wxheading{Remarks}
+%%
+%%Under X, OnEndSession is called in response to the `die' event.
+%%
+%%Under Windows, OnEndSession is called in response to the WM\_ENDSESSION message.
+%%
+%%\wxheading{See also}
+%%
+%%\helpref{wxWindow::Close}{wxwindowclose},\rtfsp
+%%\helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
+%%\helpref{wxCloseEvent}{wxcloseevent},\rtfsp
+%%\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession}
\membersection{wxApp::OnInit}\label{wxapponinit}
\func{bool}{OnInit}{\void}
This must be provided by the application, and will usually create the
-application's main window, optionally calling \helpref{wxApp::SetTopWindow}{wxappsettopwindow}.
+application's main window, optionally calling
+\helpref{wxApp::SetTopWindow}{wxappsettopwindow}.
+
+Notice that if you want to to use the command line processing provided by
+wxWindows you have to call the base class version in the derived class
+OnInit().
Return TRUE to continue processing, FALSE to exit the application.
+\membersection{wxApp::OnInitCmdLine}\label{wxapponinitcmdline}
+
+\func{void}{OnInitCmdLine}{\param{wxCmdLineParser\& }{parser}}
+
+Called from \helpref{OnInit}{wxapponinit} and may be used to initialize the
+parser with the command line options for this application. The base class
+versions adds support for a few standard options only.
+
\membersection{wxApp::OnQueryEndSession}\label{wxapponqueryendsession}
\func{void}{OnQueryEndSession}{\param{wxCloseEvent\& }{event}}
typedef wxObject* (*wxAppInitializerFunction)();
#endif
+class WXDLLEXPORT wxCmdLineParser;
+
// ----------------------------------------------------------------------------
// headers we have to include here
// ----------------------------------------------------------------------------
#include "wx/event.h" // for the base class
#if wxUSE_GUI
- #include "wx/window.h" // for wxTopLevelWindows
+ #include "wx/window.h" // for wxTopLevelWindows
#endif // wxUSE_GUI
#if wxUSE_LOG
// the virtual functions which may/must be overridden in the derived class
// -----------------------------------------------------------------------
-#ifdef __WXMAC_X__
- virtual ~wxAppBase() {} // Added min for Mac X
-#endif
+
// called during the program initialization, returning FALSE from here
// prevents the program from continuing - it's a good place to create
// the top level program window and return TRUE.
//
// Override: always in GUI application, rarely in console ones.
-#if wxUSE_GUI
- virtual bool OnInit() { return FALSE; };
-#else // !GUI
- virtual bool OnInit() { return TRUE; };
-#endif // wxUSE_GUI
+ virtual bool OnInit();
#if wxUSE_GUI
// a platform-dependent version of OnInit(): the code here is likely to
#endif // wxUSE_GUI
+ // cmd line parsing stuff
+ // ----------------------
+
+ // all of these methods may be overridden in the derived class to
+ // customize the command line parsing (by default only a few standard
+ // options are handled)
+ //
+ // you also need to call wxApp::OnInit() from YourApp::OnInit() for all
+ // this to work
+
+#if wxUSE_CMDLINE_PARSER
+ // this one is called from OnInit() to add all supported options
+ // to the given parser
+ virtual void OnInitCmdLine(wxCmdLineParser& parser);
+
+ // called after successfully parsing the command line, return TRUE
+ // to continue and FALSE to exit
+ virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
+
+ // called if "--help" option was specified, return TRUE to continue
+ // and FALSE to exit
+ virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
+
+ // called if incorrect command line options were given, return
+ // FALSE to abort and TRUE to continue
+ virtual bool OnCmdLineError(wxCmdLineParser& parser);
+#endif // wxUSE_CMDLINE_PARSER
+
// miscellaneous customization functions
// -------------------------------------
// does any of our windows has focus?
bool m_isActive;
#endif // wxUSE_GUI
+
+#ifdef __WXMAC_X__
+public:
+ virtual ~wxAppBase() {} // Added min for Mac X
+#endif
};
// ----------------------------------------------------------------------------
extern int wxEntry( int argc, char *argv[] ); \
int main(int argc, char *argv[]) { return wxEntry(argc, argv); }
#elif defined(__WXMAC__) && defined(__UNIX__)
- // wxMac seems to have a specific wxEntry prototype
+ // wxMac seems to have a specific wxEntry prototype
#define IMPLEMENT_WXWIN_MAIN \
extern int wxEntry( int argc, char *argv[], bool enterLoop = 1 ); \
int main(int argc, char *argv[]) { return wxEntry(argc, argv); }
#ifndef WX_PRECOMP
#include "wx/app.h"
+ #include "wx/intl.h"
#include "wx/list.h"
#endif
+#include "wx/cmdline.h"
#include "wx/thread.h"
#include "wx/confbase.h"
-#ifdef __WXUNIVERSAL__
- #include "wx/univ/theme.h"
-#endif // __WXUNIVERSAL__
-
// ===========================================================================
// implementation
// ===========================================================================
+// ----------------------------------------------------------------------------
+// initialization and termination
+// ----------------------------------------------------------------------------
+
wxAppBase::wxAppBase()
{
wxTheApp = (wxApp *)this;
#endif // wxUSE_GUI
}
-// ----------------------------------------------------------------------------
-// initialization and termination
-// ----------------------------------------------------------------------------
-
#if wxUSE_GUI
bool wxAppBase::OnInitGui()
{
#ifdef __WXUNIVERSAL__
- if ( !wxTheme::CreateDefault() )
+ if ( !wxTheme::Get() && !wxTheme::CreateDefault() )
return FALSE;
#endif // __WXUNIVERSAL__
}
#endif // wxUSE_GUI
+
+// ----------------------------------------------------------------------------
+// cmd line parsing
+// ----------------------------------------------------------------------------
+
+bool wxAppBase::OnInit()
+{
+#if wxUSE_CMDLINE_PARSER
+ wxCmdLineParser parser(argc, argv);
+
+ OnInitCmdLine(parser);
+
+ bool cont;
+ switch ( parser.Parse() )
+ {
+ case -1:
+ cont = OnCmdLineHelp(parser);
+ break;
+
+ case 0:
+ cont = OnCmdLineParsed(parser);
+ break;
+
+ default:
+ cont = OnCmdLineError(parser);
+ break;
+ }
+
+ if ( !cont )
+ return FALSE;
+#endif // wxUSE_CMDLINE_PARSER
+
+ return TRUE;
+}
+
+#if wxUSE_CMDLINE_PARSER
+
+#define OPTION_VERBOSE _T("verbose")
+#define OPTION_THEME _T("theme")
+
+void wxAppBase::OnInitCmdLine(wxCmdLineParser& parser)
+{
+ // the standard command line options
+ static const wxCmdLineEntryDesc cmdLineDesc[] =
+ {
+ {
+ wxCMD_LINE_SWITCH,
+ _T("h"),
+ _T("help"),
+ gettext_noop("show this help message"),
+ wxCMD_LINE_VAL_NONE,
+ wxCMD_LINE_OPTION_HELP
+ },
+
+#if wxUSE_LOG
+ {
+ wxCMD_LINE_SWITCH,
+ _T(""),
+ OPTION_VERBOSE,
+ gettext_noop("generate verbose log messages")
+ },
+#endif wxUSE_LOG
+
+#ifdef __WXUNIVERSAL__
+ {
+ wxCMD_LINE_OPTION,
+ _T(""),
+ OPTION_THEME,
+ gettext_noop("specify the theme to use"),
+ wxCMD_LINE_VAL_STRING
+ },
+#endif // __WXUNIVERSAL__
+
+ // terminator
+ { wxCMD_LINE_NONE }
+ };
+
+ parser.SetDesc(cmdLineDesc);
+}
+
+bool wxAppBase::OnCmdLineParsed(wxCmdLineParser& parser)
+{
+#if wxUSE_LOG
+ if ( parser.Found(OPTION_VERBOSE) )
+ {
+ wxLog::SetVerbose(TRUE);
+ }
+#endif // wxUSE_LOG
+
+#ifdef __WXUNIVERSAL__
+ wxString themeName;
+ if ( parser.Found(OPTION_THEME, &themeName) )
+ {
+ wxTheme *theme = wxTheme::Create(themeName);
+ if ( !theme )
+ {
+ wxLogError(_("Unsupported theme '%s'."), themeName.c_str());
+
+ return FALSE;
+ }
+
+ wxTheme::Set(theme);
+ }
+#endif // __WXUNIVERSAL__
+
+ return TRUE;
+}
+
+bool wxAppBase::OnCmdLineHelp(wxCmdLineParser& parser)
+{
+ parser.Usage();
+
+ return FALSE;
+}
+
+bool wxAppBase::OnCmdLineError(wxCmdLineParser& parser)
+{
+ parser.Usage();
+
+ return FALSE;
+}
+
+#endif // wxUSE_CMDLINE_PARSER
+
wxCmdLineParamType typ,
int fl)
{
+ wxASSERT_MSG( !shrt.empty() || !lng.empty(),
+ _T("option should have at least one name") );
+
kind = k;
shortName = shrt;
int wxCmdLineParserData::FindOption(const wxString& name)
{
- size_t count = m_options.GetCount();
- for ( size_t n = 0; n < count; n++ )
+ if ( !name.empty() )
{
- if ( m_options[n].shortName == name )
+ size_t count = m_options.GetCount();
+ for ( size_t n = 0; n < count; n++ )
{
- // found
- return n;
+ if ( m_options[n].shortName == name )
+ {
+ // found
+ return n;
+ }
}
}
bool wxCmdLineParser::Found(const wxString& name) const
{
int i = m_data->FindOption(name);
+ if ( i == wxNOT_FOUND )
+ i = m_data->FindOptionByLongName(name);
+
wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown switch") );
wxCmdLineOption& opt = m_data->m_options[(size_t)i];
bool wxCmdLineParser::Found(const wxString& name, wxString *value) const
{
int i = m_data->FindOption(name);
+ if ( i == wxNOT_FOUND )
+ i = m_data->FindOptionByLongName(name);
+
wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
wxCmdLineOption& opt = m_data->m_options[(size_t)i];
bool wxCmdLineParser::Found(const wxString& name, long *value) const
{
int i = m_data->FindOption(name);
+ if ( i == wxNOT_FOUND )
+ i = m_data->FindOptionByLongName(name);
+
wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
wxCmdLineOption& opt = m_data->m_options[(size_t)i];
bool wxCmdLineParser::Found(const wxString& name, wxDateTime *value) const
{
int i = m_data->FindOption(name);
+ if ( i == wxNOT_FOUND )
+ i = m_data->FindOptionByLongName(name);
+
wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
wxCmdLineOption& opt = m_data->m_options[(size_t)i];
projects / wxWidgets.git / commitdiff
