From e96155fecee150af5436fc26e8d55a4dbd8fc5f8 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Thu, 13 Aug 2020 23:08:58 +0200 Subject: [PATCH] Fix and improve wxDC background mode documentation Use wxBRUSHSTYLE_SOLID/TRANSPARENT constants instead of wxPENSTYLE_XXX ones, as even though they have the same values, using brush style for the background makes more sense. Also document that the default background mode is transparent. --- interface/wx/dc.h | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/interface/wx/dc.h b/interface/wx/dc.h index 527d97eb64af..bf1ca7db644b 100644 --- a/interface/wx/dc.h +++ b/interface/wx/dc.h @@ -997,7 +997,7 @@ class wxDC : public wxObject //@{ /** - Returns the current background mode: @c wxPENSTYLE_SOLID or @c wxPENSTYLE_TRANSPARENT. + Returns the current background mode: @c wxBRUSHSTYLE_SOLID or @c wxBRUSHSTYLE_TRANSPARENT. @see SetBackgroundMode() */ @@ -1037,10 +1037,15 @@ class wxDC : public wxObject const wxColour& GetTextForeground() const; /** - @a mode may be one of @c wxPENSTYLE_SOLID and @c wxPENSTYLE_TRANSPARENT. + Change the current background mode. This setting determines whether text will be drawn with a background colour or not. + + Default is @c wxBRUSHSTYLE_TRANSPARENT, i.e. text background is not + drawn. + + @param mode one of @c wxBRUSHSTYLE_SOLID and @c wxBRUSHSTYLE_TRANSPARENT. */ void SetBackgroundMode(int mode); @@ -1980,7 +1985,8 @@ class wxDCBgModeChanger @param dc The DC where the mode must be temporary set. @param mode - The background mode to set. + The background mode to set, one of @c wxBRUSHSTYLE_SOLID or @c + wxBRUSHSTYLE_TRANSPARENT. */ wxDCBgModeChanger(wxDC& dc, int mode);