\helpref{IMPLEMENT\_CLASS}{implementclass}\\
\helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\
\helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\
-\helpref{wxCONCAT}{wxconcat}\\
-\helpref{WXDEBUG\_NEW}{debugnew}\\
-\helpref{WXTRACELEVEL}{tracelevel}\\
-\helpref{WXTRACE}{trace}\\
+\helpref{wxASSERT}{wxassert}\\
\helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}\\
\helpref{wxASSERT\_MSG}{wxassertmsg}\\
-\helpref{wxASSERT}{wxassert}\\
-\helpref{wxBITMAP}{wxbitmapmacro}\\
\helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
\helpref{wxBell}{wxbell}\\
+\helpref{wxBITMAP}{wxbitmapmacro}\\
\helpref{wxCHANGE\_UMASK}{wxchangeumask}\\
\helpref{wxCHECK}{wxcheck}\\
\helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
\helpref{wxColourDisplay}{wxcolourdisplay}\\
\helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}\\
\helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}\\
+\helpref{wxCONCAT}{wxconcat}\\
\helpref{wxConcatFiles}{wxconcatfiles}\\
\helpref{wxConstCast}{wxconstcast}\\
\helpref{wxCopyFile}{wxcopyfile}\\
\helpref{wxDDEInitialize}{wxddeinitialize}\\
\helpref{wxDROP\_ICON}{wxdropicon}\\
\helpref{wxDebugMsg}{wxdebugmsg}\\
+\helpref{WXDEBUG\_NEW}{debugnew}\\
+\helpref{wxDirExists}{functionwxdirexists}\\
\helpref{wxDirSelector}{wxdirselector}\\
\helpref{wxDisplayDepth}{wxdisplaydepth}\\
\helpref{wxDisplaySize}{wxdisplaysize}\\
\helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\
\helpref{wxGetLocalTime}{wxgetlocaltime}\\
\helpref{wxGetMousePosition}{wxgetmouseposition}\\
+\helpref{wxGetMouseState}{wxgetmousestate}\\
\helpref{wxGetMultipleChoices}{wxgetmultiplechoices}\\
\helpref{wxGetMultipleChoice}{wxgetmultiplechoice}\\
\helpref{wxGetNumberFromUser}{wxgetnumberfromuser}\\
\helpref{wxON\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj}\\
\helpref{wxOpenClipboard}{wxopenclipboard}\\
\helpref{wxParseCommonDialogsFilter}{wxparsecommondialogsfilter}\\
-\helpref{wxDirExists}{functionwxdirexists}\\
\helpref{wxPathOnly}{wxpathonly}\\
+\helpref{wxPLURAL}{wxplural}\\
\helpref{wxPostDelete}{wxpostdelete}\\
\helpref{wxPostEvent}{wxpostevent}\\
\helpref{wxRegisterClipboardFormat}{wxregisterclipboardformat}\\
\helpref{wxStringTokenize}{wxstringtokenize}\\
\helpref{wxStripMenuCodes}{wxstripmenucodes}\\
\helpref{wxStrlen}{wxstrlen}\\
+\helpref{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{wxsuppressgccprivatedtorwarning}\\
\helpref{wxSysErrorCode}{wxsyserrorcode}\\
\helpref{wxSysErrorMsg}{wxsyserrormsg}\\
\helpref{wxT}{wxt}\\
-\helpref{wxTraceLevel}{wxtracelevel}\\
\helpref{wxTrace}{wxtrace}\\
+\helpref{WXTRACE}{trace}\\
+\helpref{wxTraceLevel}{wxtracelevel}\\
+\helpref{WXTRACELEVEL}{tracelevel}\\
\helpref{wxTransferFileToStream}{wxtransferfiletostream}\\
\helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\
\helpref{wxTrap}{wxtrap}\\
\helpref{wx\_static\_cast}{wxstaticcastraw}\\
\helpref{wx\_truncate\_cast}{wxtruncatecast}\\
\helpref{\_}{underscore}\\
-\helpref{wxPLURAL}{wxplural}\\
\helpref{\_T}{underscoret}
+\helpref{\_\_WXFUNCTION\_\_}{wxfunction}
Under Unix the flag {\tt wxEXEC\_MAKE\_GROUP\_LEADER} may be used to ensure
that the new process is a group leader (this will create a new session if
needed). Calling \helpref{wxKill}{wxkill} passing wxKILL\_CHILDREN will
-will kill this process as well as all of its children (except those which have
+kill this process as well as all of its children (except those which have
started their own session).
Finally, you may use the third overloaded version of this function to execute
no default filename will be supplied. The wildcard determines what files
are displayed in the file selector, and file extension supplies a type
extension for the required filename. Flags may be a combination of wxOPEN,
-wxSAVE, wxOVERWRITE\_PROMPT, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
+wxSAVE, wxOVERWRITE\_PROMPT or wxFILE\_MUST\_EXIST. Note that wxMULTIPLE
+can only be used with \helpref{wxFileDialog}{wxfiledialog} and not here as this
+function only returns a single file name.
Both the Unix and Windows versions implement a wildcard filter. Typing a
filename containing wildcards (*, ?) in the filename text item, and
\membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
-\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
+\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}}
Shows the colour selection dialog and returns the colour selected by user or
invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
\docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
+\docparam{caption}{If given, this will be used for the dialog caption.}
+
\wxheading{Include files}
<wx/colordlg.h>
\membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
-\func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
+\func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}, \param{const wxString\& }{caption = wxEmptyString}}
Shows the font selection dialog and returns the font selected by user or
invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font
\docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
+\docparam{caption}{If given, this will be used for the dialog caption.}
+
\wxheading{Include files}
<wx/fontdlg.h>
\begin{twocollist}\itemsep=0pt
\twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
wxCANCEL.}
-\twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
+\twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May only be combined with
wxYES\_NO or wxOK.}
\twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
\twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
\func{wxWindow *}{wxGetActiveWindow}{\void}
-Gets the currently active window (Windows only).
+Gets the currently active window (implemented for MSW and GTK only currently,
+always returns \NULL in the other ports).
\wxheading{Include files}
<wx/utils.h>
+\membersection{::wxGetMouseState}\label{wxgetmousestate}
+
+\func{wxMouseState}{wxGetMouseState}{\void}
+
+Returns the current state of the mouse. Returns a wxMouseState
+instance that contains the current position of the mouse pointer in
+screen coordinants, as well as boolean values indicating the up/down
+status of the mouse buttons and the modifier keys.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+wxMouseState has the following interface:
+
+\begin{verbatim}
+class wxMouseState
+{
+public:
+ wxMouseState();
+
+ wxCoord GetX();
+ wxCoord GetY();
+
+ bool LeftDown();
+ bool MiddleDown();
+ bool RightDown();
+
+ bool ControlDown();
+ bool ShiftDown();
+ bool AltDown();
+ bool MetaDown();
+ bool CmdDown();
+
+ void SetX(wxCoord x);
+ void SetY(wxCoord y);
+
+ void SetLeftDown(bool down);
+ void SetMiddleDown(bool down);
+ void SetRightDown(bool down);
+
+ void SetControlDown(bool down);
+ void SetShiftDown(bool down);
+ void SetAltDown(bool down);
+ void SetMetaDown(bool down);
+};
+\end{verbatim}
+
+
\membersection{::wxGetResource}\label{wxgetresource}
\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
<wx/utils.h>
+\membersection{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}\label{wxsuppressgccprivatedtorwarning}
+
+\func{}{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{\param{}{name}}
+
+GNU C++ compiler gives a warning for any class whose destructor is private
+unless it has a friend. This warning may sometimes be useful but it doesn't
+make sense for reference counted class which always delete themselves (hence
+destructor should be private) but don't necessarily have any friends, so this
+macro is provided to disable the warning in such case. The \arg{name} parameter
+should be the name of the class but is only used to construct a unique friend
+class name internally. Example of using the macro:
+
+\begin{verbatim}
+ class RefCounted
+ {
+ public:
+ RefCounted() { m_nRef = 1; }
+ void IncRef() { m_nRef++ ; }
+ void DecRef() { if ( !--m_nRef ) delete this; }
+
+ private:
+ ~RefCounted() { }
+
+ wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted)
+ };
+\end{verbatim}
+
+Notice that there should be no semicolon after this macro.
+
+
\membersection{wxULL}\label{wxull}
\func{wxLongLong\_t}{wxULL}{\param{}{number}}
<wx/utils.h>
+\membersection{\_\_WXFUNCTION\_\_}\label{wxfunction}
+
+\func{}{\_\_WXFUNCTION\_\_}{\void}
+
+This macro expands to the name of the current function if the compiler supports
+any of \texttt{\_\_FUNCTION\_\_}, \texttt{\_\_func\_\_} or equivalent variables
+or macros or to \NULL if none of them is available.
+
+
\section{Byte order macros}\label{byteordermacros}
\membersection{::wxOnAssert}\label{wxonassert}
-\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
+\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{func}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
This function is called whenever one of debugging macros fails (i.e. condition
is false in an assertion). It is only defined in the debug mode, in release
To override the default behaviour in the debug builds which is to show the user
a dialog asking whether he wants to abort the program, continue or continue
ignoring any subsequent assert failures, you may override
-\helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
+\helpref{wxApp::OnAssertFailure}{wxapponassertfailure} which is called by this function if
the global application object exists.
projects / wxWidgets.git / blobdiff