[wxWidgets.git] / docs / latex / wx / tusage.tex

\section{Notes on using the reference}\label{referencenotes}

In the descriptions of the wxWidgets classes and their member
functions, note that descriptions of inherited member functions are not
duplicated in derived classes unless their behaviour is different. So in
using a class such as wxScrolledWindow, be aware that wxWindow functions may be
relevant.

Note also that arguments with default values may be omitted from a
function call, for brevity. Size and position arguments may usually be
given a value of -1 (the default), in which case wxWidgets will choose a
suitable value.

Most strings are returned as wxString objects. However, for remaining
char * return values, the strings are allocated and
deallocated by wxWidgets. Therefore, return values should always be
copied for long-term use, especially since the same buffer is often
used by wxWidgets.

The member functions are given in alphabetical order except for
constructors and destructors which appear first.
Commit	Line	Data
a660d684 KB	1	\section{Notes on using the reference}\label{referencenotes}
a660d684 KB	2
fc2171bd	3	In the descriptions of the wxWidgets classes and their member
a660d684 KB	4	functions, note that descriptions of inherited member functions are not
a660d684 KB	5	duplicated in derived classes unless their behaviour is different. So in
fe604ccd	6	using a class such as wxScrolledWindow, be aware that wxWindow functions may be
a660d684 KB	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
fc2171bd	11	given a value of -1 (the default), in which case wxWidgets will choose a
a660d684 KB	12	suitable value.
	13
	14	Most strings are returned as wxString objects. However, for remaining
	15	char * return values, the strings are allocated and
fc2171bd	16	deallocated by wxWidgets. Therefore, return values should always be
a660d684	17	copied for long-term use, especially since the same buffer is often
fc2171bd	18	used by wxWidgets.
a660d684 KB	19
	20	The member functions are given in alphabetical order except for
	21	constructors and destructors which appear first.
	22