1998-05-20 10:25:30 -04:00
|
|
|
\section{Notes on using the reference}\label{referencenotes}
|
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
In the descriptions of the wxWidgets classes and their member
|
1998-05-20 10:25:30 -04:00
|
|
|
functions, note that descriptions of inherited member functions are not
|
|
|
|
duplicated in derived classes unless their behaviour is different. So in
|
1998-06-14 16:48:39 -04:00
|
|
|
using a class such as wxScrolledWindow, be aware that wxWindow functions may be
|
1998-05-20 10:25:30 -04:00
|
|
|
relevant.
|
|
|
|
|
|
|
|
Note also that arguments with default values may be omitted from a
|
|
|
|
function call, for brevity. Size and position arguments may usually be
|
2004-05-04 04:27:20 -04:00
|
|
|
given a value of -1 (the default), in which case wxWidgets will choose a
|
1998-05-20 10:25:30 -04:00
|
|
|
suitable value.
|
|
|
|
|
|
|
|
Most strings are returned as wxString objects. However, for remaining
|
|
|
|
char * return values, the strings are allocated and
|
2004-05-04 04:27:20 -04:00
|
|
|
deallocated by wxWidgets. Therefore, return values should always be
|
1998-05-20 10:25:30 -04:00
|
|
|
copied for long-term use, especially since the same buffer is often
|
2004-05-04 04:27:20 -04:00
|
|
|
used by wxWidgets.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
The member functions are given in alphabetical order except for
|
|
|
|
constructors and destructors which appear first.
|
|
|
|
|