| 1 | \section{Notes on using the reference}\label{referencenotes} |
| 2 | |
| 3 | In the descriptions of the wxWidgets classes and their member |
| 4 | functions, note that descriptions of inherited member functions are not |
| 5 | duplicated in derived classes unless their behaviour is different. So in |
| 6 | using a class such as wxScrolledWindow, be aware that wxWindow functions may be |
| 7 | relevant. |
| 8 | |
| 9 | Note also that arguments with default values may be omitted from a |
| 10 | function call, for brevity. Size and position arguments may usually be |
| 11 | given a value of -1 (the default), in which case wxWidgets will choose a |
| 12 | suitable value. |
| 13 | |
| 14 | Most strings are returned as wxString objects. However, for remaining |
| 15 | char * return values, the strings are allocated and |
| 16 | deallocated by wxWidgets. Therefore, return values should always be |
| 17 | copied for long-term use, especially since the same buffer is often |
| 18 | used by wxWidgets. |
| 19 | |
| 20 | The member functions are given in alphabetical order except for |
| 21 | constructors and destructors which appear first. |
| 22 | |