X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/36c9828f702fb504b07968703bcd82f04196070a..3b88355f59ffadc66f5f76816d4732a607702fc6:/docs/doxygen/overviews/dc.h diff --git a/docs/doxygen/overviews/dc.h b/docs/doxygen/overviews/dc.h index bfcbc7275a..69c496d217 100644 --- a/docs/doxygen/overviews/dc.h +++ b/docs/doxygen/overviews/dc.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: dc +// Name: dc.h // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ @@ -8,35 +8,34 @@ /*! - @page dc_overview Device context overview + @page overview_dc Device context overview Classes: #wxBufferedDC, #wxBufferedPaintDC, #wxDC, #wxPostScriptDC, - #wxMetafileDC, #wxMemoryDC, #wxPrinterDC, - #wxScreenDC, #wxClientDC, #wxPaintDC, - #wxWindowDC. - A wxDC is a @e device context onto which graphics and text can be drawn. - The device context is intended to represent a number of output devices in a generic way, - with the same API being used throughout. - Some device contexts are created temporarily in order to draw on a window. - This is @true of #wxScreenDC, #wxClientDC, #wxPaintDC, - and #wxWindowDC. The following describes the differences between - these device contexts and when you should use them. - + #wxMetafileDC, #wxMemoryDC, #wxPrinterDC, #wxScreenDC, #wxClientDC, + #wxPaintDC, #wxWindowDC. - @b wxScreenDC. Use this to paint on the screen, as opposed to an individual window. - @b wxClientDC. Use this to paint on the client area of window (the part without - borders and other decorations), but do not use it from within an #wxPaintEvent. - @b wxPaintDC. Use this to paint on the client area of a window, but @e only from - within a #wxPaintEvent. - @b wxWindowDC. Use this to paint on the whole area of a window, including decorations. - This may not be available on non-Windows platforms. + A wxDC is a @e device context onto which graphics and text can be drawn. + The device context is intended to represent a number of output devices in a + generic way, with the same API being used throughout. + Some device contexts are created temporarily in order to draw on a window. + This is @true of #wxScreenDC, #wxClientDC, #wxPaintDC, and #wxWindowDC. + The following describes the differences between these device contexts and + when you should use them. + + @li @b wxScreenDC. Use this to paint on the screen, as opposed to an individual window. + @li @b wxClientDC. Use this to paint on the client area of window (the part without + borders and other decorations), but do not use it from within an #wxPaintEvent. + @li @b wxPaintDC. Use this to paint on the client area of a window, but @e only from + within a #wxPaintEvent. + @li @b wxWindowDC. Use this to paint on the whole area of a window, including decorations. + This may not be available on non-Windows platforms. To use a client, paint or window device context, create an object on the stack with the window as argument, for example: @code - void MyWindow::OnMyCmd(wxCommandEvent& event) + void MyWindow::OnMyCmd(wxCommandEvent& event) { wxClientDC dc(window); DrawMyPicture(dc); @@ -48,6 +47,5 @@ work for everything (for example not all device contexts support bitmap drawing) but will work most of the time. - */ - +*/