From 4f0c6c9a3a1a81d7b64eff65fd370afb99eb82e6 Mon Sep 17 00:00:00 2001 From: Mat M Date: Sun, 4 Dec 2016 19:30:53 -0500 Subject: [PATCH] Amend documentation regarding image/selected image parameters Make it clear that the "image" argument is only used if it's valid. --- interface/wx/treectrl.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h index c119aca425..0a73785bde 100644 --- a/interface/wx/treectrl.h +++ b/interface/wx/treectrl.h @@ -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,