]>
Commit | Line | Data |
---|---|---|
15b6757b | 1 | ///////////////////////////////////////////////////////////////////////////// |
72844950 | 2 | // Name: referencenotes.h |
15b6757b FM |
3 | // Purpose: topic overview |
4 | // Author: wxWidgets team | |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
880efa2a | 9 | /** |
36c9828f | 10 | |
72844950 | 11 | @page overview_referencenotes Notes on Using the Reference |
36c9828f | 12 | |
72844950 BP |
13 | In the descriptions of the wxWidgets classes and their member functions, note |
14 | that descriptions of inherited member functions are not duplicated in derived | |
15 | classes unless their behaviour is different. So in using a class such as | |
16 | wxScrolledWindow, be aware that wxWindow functions may be relevant. | |
17 | ||
18 | Note also that arguments with default values may be omitted from a function | |
19 | call, for brevity. Size and position arguments may usually be given a value of | |
20 | -1 (the default), in which case wxWidgets will choose a suitable value. | |
21 | ||
22 | Most strings are returned as wxString objects. However, for remaining char * | |
23 | return values, the strings are allocated and deallocated by wxWidgets. | |
24 | Therefore, return values should always be copied for long-term use, especially | |
25 | since the same buffer is often used by wxWidgets. | |
26 | ||
27 | The member functions are given in alphabetical order except for constructors | |
28 | and destructors which appear first. | |
29 | ||
30 | */ | |
36c9828f | 31 |