X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d50fc4dc6d4832d4678c6e99085198cafaeabb9a..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/bannerwindow.h?ds=sidebyside diff --git a/interface/wx/bannerwindow.h b/interface/wx/bannerwindow.h index e91073ff3a..ad50e6b78c 100644 --- a/interface/wx/bannerwindow.h +++ b/interface/wx/bannerwindow.h @@ -3,7 +3,6 @@ // Purpose: wxBannerWindow class documentation // Author: Vadim Zeitlin // Created: 2011-08-16 -// RCS-ID: $Id$ // Copyright: (c) 2011 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// @@ -113,14 +112,20 @@ public: /** Provide the bitmap to use as background. - Notice that the bitmap should be big enough to always cover the entire - banner, e.g. for a horizontal banner with wxTOP style its width should - be bigger than any reasonable window size. - - For wxLEFT orientation the bitmap is truncated from the top, for wxTOP - and wxBOTTOM -- from the right and for wxRIGHT -- from the bottom, so - put the most important part of the bitmap information in the opposite - direction. + Notice that ideally the bitmap should be big enough to always cover the + entire banner, e.g. for a horizontal banner with wxTOP style its width + should be bigger than any reasonable window size. Otherwise the bitmap + is extended to cover the entire window area with a solid colour taken + from the bitmap pixel on the edge in which direction the extension + occurs so all bitmap pixels on this edge (top for wxLEFT, right for + wxTOP and wxBOTTOM and bottom for wxRIGHT) should have the same colour + to avoid jarring discontinuity. + + If, on the other hand, the bitmap is bigger than the window size, then + it is truncated. For wxLEFT orientation the bitmap is truncated from + the top, for wxTOP and wxBOTTOM -- from the right and for wxRIGHT -- + from the bottom, so put the most important part of the bitmap + information in the opposite direction where it will never be truncated. If no valid background bitmap is specified, the banner draws gradient background but if a valid bitmap is given here, the gradient is not