Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More docstrings.

Browse Source 
Fixed wxWave compilation on Linux.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@24612 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2003-11-20 01:19:37 +00:00
parent ce8f00f30c
commit 6c3b4aae47
7 changed files with 484 additions and 268 deletions
Download Patch File Download Diff File Expand all files Collapse all files

287
wxPython/src/_app.i
View File

@@ -59,96 +59,133 @@ public:
void _setCallbackInfo(PyObject* self, PyObject* _class);
// set/get the application name
wxString GetAppName() const;
void SetAppName(const wxString& name);
// set/get the app class name
wxString GetClassName() const;
void SetClassName(const wxString& name);
DocDeclStr(
wxString, GetAppName() const,
"Get the application name.");
DocDeclStr(
void, SetAppName(const wxString& name),
"Set the application name. This value may be used automatically\n"
"by wxConfig and such.");
// set/get the vendor name
const wxString& GetVendorName() const;
void SetVendorName(const wxString& name);
DocDeclStr(
wxString, GetClassName() const,
"Get the application's class name.");
DocDeclStr(
void, SetClassName(const wxString& name),
"Set the application's class name. This value may be used for X-resources if\n"
"applicable for the platform");
// create the app traits object to which we delegate for everything which
// either should be configurable by the user (then he can change the
// default behaviour simply by overriding CreateTraits() and returning his
// own traits object) or which is GUI/console dependent as then wxAppTraits
// allows us to abstract the differences behind the common fa<EFBFBD>ade
wxAppTraits *GetTraits();
// process all events in the wxPendingEvents list -- it is necessary to
// call this function to process posted events. This happens during each
// event loop iteration.
virtual void ProcessPendingEvents();
// process all currently pending events right now
//
// it is an error to call Yield() recursively unless the value of
// onlyIfNeeded is True
//
// WARNING: this function is dangerous as it can lead to unexpected
// reentrancies (i.e. when called from an event handler it
// may result in calling the same event handler again), use
// with _extreme_ care or, better, don't use at all!
virtual bool Yield(bool onlyIfNeeded = False);
// make sure that idle events are sent again
virtual void WakeUpIdle();
DocDeclStr(
const wxString&, GetVendorName() const,
"Get the application's vendor name.");
DocDeclStr(
void, SetVendorName(const wxString& name),
"Set the application's vendor name. This value may be used automatically\n"
"by wxConfig and such.");
// execute the main GUI loop, the function returns when the loop ends
virtual int MainLoop();
// exit the main loop thus terminating the application
virtual void Exit();
// exit the main GUI loop during the next iteration (i.e. it does not
// stop the program immediately!)
virtual void ExitMainLoop();
// returns True if there are unprocessed events in the event queue
virtual bool Pending();
// process the first event in the event queue (blocks until an event
// apperas if there are none currently)
virtual bool Dispatch();
DocDeclStr(
wxAppTraits*, GetTraits(),
"Create the app traits object to which we delegate for everything which either\n"
"should be configurable by the user (then he can change the default behaviour\n"
"simply by overriding CreateTraits() and returning his own traits object) or\n"
"which is GUI/console dependent as then wxAppTraits allows us to abstract the\n"
"differences behind the common facade");
// this virtual function is called in the GUI mode when the application
// becomes idle and normally just sends wxIdleEvent to all interested
// parties
//
// 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);
// Perform standard OnIdle behaviour: call from port's OnIdle
void OnIdle(wxIdleEvent& event);
DocDeclStr(
virtual void, ProcessPendingEvents(),
"Process all events in the wxPendingEvents list -- it is necessary to call this\n"
"function to process posted events. This happens during each event loop\n"
"iteration.");
// return True if our app has focus
virtual bool IsActive() const;
DocDeclStr(
virtual bool, Yield(bool onlyIfNeeded = False),
"Process all currently pending events right now, instead of waiting until\n"
"return to the event loop. It is an error to call Yield() recursively unless\n"
"the value of onlyIfNeeded is True.\n"
"\n"
"WARNING: This function is dangerous as it can lead to unexpected\n"
" reentrancies (i.e. when called from an event handler it\n"
" may result in calling the same event handler again), use\n"
" with _extreme_ care or, better, don't use at all!\n");
// set the "main" top level window
void SetTopWindow(wxWindow *win);
DocDeclStr(
virtual void, WakeUpIdle(),
"Make sure that idle events are sent again");
// return the "main" top level window (if it hadn't been set previously
// with SetTopWindow(), will return just some top level window and, if
// there are none, will return NULL)
virtual wxWindow *GetTopWindow() const;
// control the exit behaviour: by default, the program will exit the
// main loop (and so, usually, terminate) when the last top-level
// program window is deleted. Beware that if you disable this behaviour
// (with SetExitOnFrameDelete(False)), you'll have to call
// ExitMainLoop() explicitly from somewhere.
void SetExitOnFrameDelete(bool flag);
bool GetExitOnFrameDelete() const;
DocDeclStr(
virtual int, MainLoop(),
"Execute the main GUI loop, the function returns when the loop ends.");
DocDeclStr(
virtual void, Exit(),
"Exit the main loop thus terminating the application.");
DocDeclStr(
virtual void, ExitMainLoop(),
"Exit the main GUI loop during the next iteration (i.e. it does not\n"
"stop the program immediately!)");
DocDeclStr(
virtual bool, Pending(),
"Returns True if there are unprocessed events in the event queue.");
DocDeclStr(
virtual bool, Dispatch(),
"Process the first event in the event queue (blocks until an event\n"
"appears if there are none currently)");
DocDeclStr(
virtual bool, ProcessIdle(),
"Called from the MainLoop when the application becomes idle and sends an\n"
"IdleEvent to all interested parties. Returns True is more idle events are\n"
"needed, False if not.");
DocDeclStr(
virtual bool, SendIdleEvents(wxWindow* win, wxIdleEvent& event),
"Send idle event to window and all subwindows. Returns True if more idle time\n"
"is requested.");
DocDeclStr(
virtual bool, IsActive() const,
"Return True if our app has focus.");
DocDeclStr(
void, SetTopWindow(wxWindow *win),
"Set the \"main\" top level window");
DocDeclStr(
virtual wxWindow*, GetTopWindow() const,
"Return the \"main\" top level window (if it hadn't been set previously with\n"
"SetTopWindow(), will return just some top level window and, if there not any,\n"
"will return None)");
DocDeclStr(
void, SetExitOnFrameDelete(bool flag),
"Control the exit behaviour: by default, the program will exit the main loop\n"
"(and so, usually, terminate) when the last top-level program window is\n"
"deleted. Beware that if you disable this behaviour (with\n"
"SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop() explicitly\n"
"from somewhere.\n");
DocDeclStr(
bool, GetExitOnFrameDelete() const,
"Get the current exit behaviour setting.");
#if 0
// Get display mode that is used use. This is only used in framebuffer
@@ -161,9 +198,16 @@ public:
virtual bool SetDisplayMode(const wxVideoMode& info);
#endif
// set use of best visual flag (see below)
void SetUseBestVisual( bool flag );
bool GetUseBestVisual() const;
DocDeclStr(
void, SetUseBestVisual( bool flag ),
"Set whether the app should try to use the best available visual on systems\n"
"where more than one is available, (Sun, SGI, XFree86 4, etc.)");
DocDeclStr(
bool, GetUseBestVisual() const,
"Get current UseBestVisual setting.");
// set/get printing mode: see wxPRINT_XXX constants.
//
@@ -172,14 +216,20 @@ public:
virtual void SetPrintMode(int mode);
int GetPrintMode() const;
// Get/Set OnAssert behaviour. The following flags may be or'd together:
//
// wxPYAPP_ASSERT_SUPPRESS Don't do anything
// wxPYAPP_ASSERT_EXCEPTION Turn it into a Python exception if possible
// wxPYAPP_ASSERT_DIALOG Display a message dialog
// wxPYAPP_ASSERT_LOG Write the assertion info to the wxLog
int GetAssertMode();
void SetAssertMode(int mode);
DocDeclStr(
void, SetAssertMode(int mode),
"Set the OnAssert behaviour for debug and hybrid builds. The following flags\n"
"may be or'd together:\n"
"\n"
" wxPYAPP_ASSERT_SUPPRESS Don't do anything\n"
" wxPYAPP_ASSERT_EXCEPTION Turn it into a Python exception if possible (default)\n"
" wxPYAPP_ASSERT_DIALOG Display a message dialog\n"
" wxPYAPP_ASSERT_LOG Write the assertion info to the wxLog\n");
DocDeclStr(
int, GetAssertMode(),
"Get the current OnAssert behaviour setting.");
static bool GetMacSupportPCMenuShortcuts();
@@ -194,12 +244,15 @@ public:
static void SetMacExitMenuItemId(long val);
static void SetMacHelpMenuTitleName(const wxString& val);
// For internal use only
void _BootstrapApp();
DocDeclStr(
void, _BootstrapApp(),
"For internal use only");
DocStr(GetComCtl32Version,
"Returns 400, 470, 471 for comctl32.dll 4.00, 4.70, 4.71 or 0 if it\n"
"wasn't found at all. Raises an exception on non-Windows platforms.");
#ifdef __WXMSW__
// returns 400, 470, 471 for comctl32.dll 4.00, 4.70, 4.71 or 0 if it
// wasn't found at all
static int GetComCtl32Version();
#else
%extend {
@@ -214,28 +267,52 @@ public:
//---------------------------------------------------------------------------
%newgroup;
// Force an exit from main loop
void wxExit();
// Yield to other apps/messages
bool wxYield();
bool wxYieldIfNeeded();
bool wxSafeYield(wxWindow* win=NULL, bool onlyIfNeeded=False);
DocDeclStr(
void, wxExit(),
"Force an exit of the application. Convenience for wx.GetApp().Exit()");
// Cause the message queue to become empty again
void wxWakeUpIdle();
// Send an event to be processed later
void wxPostEvent(wxEvtHandler *dest, wxEvent& event);
DocDeclStr(
bool, wxYield(),
"Yield to other apps/messages. Convenience for wx.GetApp().Yield()");
// This is used to cleanup after wxWindows when Python shuts down.
DocDeclStr(
bool, wxYieldIfNeeded(),
"Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)");
DocDeclStr(
bool, wxSafeYield(wxWindow* win=NULL, bool onlyIfNeeded=False),
"This function is similar to wx.Yield, except that it disables the user input\n"
"to all program windows before calling wx.Yield and re-enables it again\n"
"afterwards. If win is not None, this window will remain enabled, allowing the\n"
"implementation of some limited user interaction.\n"
"\n"
"Returns the result of the call to wx.Yield.");
DocDeclStr(
void, wxWakeUpIdle(),
"Cause the message queue to become empty again, so idle events will be sent.");
DocDeclStr(
void, wxPostEvent(wxEvtHandler *dest, wxEvent& event),
"Send an event to a window or other wx.EvtHandler to be processed later.");
DocStr(wxApp_CleanUp,
"For internal use only, it is used to cleanup after wxWindows when Python shuts down.");
%inline %{
void wxApp_CleanUp() {
__wxPyCleanup();
}
%}
// Return a reference to the current wxApp object.
DocStr(wxGetApp,
"Return a reference to the current wxApp object.");
%inline %{
wxPyApp* wxGetApp() {
return (wxPyApp*)wxTheApp;