Amend documentation regarding image/selected image parameters

Make it clear that the "image" argument is only used if it's valid.
This commit is contained in:
Mat M
2016-12-04 19:30:53 -05:00
committed by VZ
parent 7cab4bbb20
commit 4f0c6c9a3a

View File

@@ -208,7 +208,7 @@ public:
The @a image and @a selImage parameters are an index within the normal
image list specifying the image to use for unselected and selected
items, respectively. If @a image -1 and @a selImage is -1, the same
items, respectively. If @a image > -1 and @a selImage is -1, the same
image is used for both selected and unselected items.
*/
virtual wxTreeItemId AddRoot(const wxString& text, int image = -1,
@@ -693,7 +693,7 @@ public:
The @a image and @a selImage parameters are an index within the normal
image list specifying the image to use for unselected and selected
items, respectively. If @a image -1 and @a selImage is -1, the same
items, respectively. If @a image > -1 and @a selImage is -1, the same
image is used for both selected and unselected items.
*/
wxTreeItemId InsertItem(const wxTreeItemId& parent,
@@ -710,7 +710,7 @@ public:
The @a image and @a selImage parameters are an index within the normal
image list specifying the image to use for unselected and selected
items, respectively. If @a image -1 and @a selImage is -1, the same
items, respectively. If @a image > -1 and @a selImage is -1, the same
image is used for both selected and unselected items.
*/
wxTreeItemId InsertItem(const wxTreeItemId& parent,
@@ -776,7 +776,7 @@ public:
The @a image and @a selImage parameters are an index within the normal
image list specifying the image to use for unselected and selected
items, respectively. If @a image -1 and @a selImage is -1, the same
items, respectively. If @a image > -1 and @a selImage is -1, the same
image is used for both selected and unselected items.
*/
wxTreeItemId PrependItem(const wxTreeItemId& parent,