X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12a44087e448071f9f108208a0a88e908d543d44..0180dad680ecbe4cb5cf8e6e45ce569f7a1029f7:/docs/latex/wx/pen.tex?ds=sidebyside diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex index 5a369a3424..361ab2f26c 100644 --- a/docs/latex/wx/pen.tex +++ b/docs/latex/wx/pen.tex @@ -4,6 +4,34 @@ A pen is a drawing tool for drawing outlines. It is used for drawing lines and painting the outline of rectangles, ellipses, etc. It has a colour, a width and a style. +\wxheading{Derived from} + +\helpref{wxGDIObject}{wxgdiobject}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Predefined objects} + +Objects: + +{\bf wxNullPen} + +Pointers: + +{\bf wxRED\_PEN\\ +wxCYAN\_PEN\\ +wxGREEN\_PEN\\ +wxBLACK\_PEN\\ +wxWHITE\_PEN\\ +wxTRANSPARENT\_PEN\\ +wxBLACK\_DASHED\_PEN\\ +wxGREY\_PEN\\ +wxMEDIUM\_GREY\_PEN\\ +wxLIGHT\_GREY\_PEN} + \wxheading{Remarks} On a monochrome display, wxWindows shows all non-white pens as black. @@ -26,8 +54,7 @@ efficiency problems. Once one wxPen object changes its data it will create its own pen data internally so that other pens, which previously shared the data using the reference counting, are not affected. -TODO: an overview for wxPen. - +%TODO: an overview for wxPen. \wxheading{See also} \helpref{wxPenList}{wxpenlist}, \helpref{wxDC}{wxdc}, \helpref{wxDC::SetPen}{wxdcsetpen} @@ -235,8 +262,7 @@ with the pen. The array is not deallocated by wxPen, but neither must it be deallocated by the calling application until the pen is deleted or this function is called with a NULL array. -TODO: describe in detail. - +%TODO: describe in detail. \wxheading{See also} \helpref{wxPen::GetDashes}{wxpengetdashes} @@ -369,7 +395,9 @@ to the pen list, and returns it. \docparam{colour}{Colour object.} -\docparam{colourName}{Colour name, which should be in the colour database.} +\docparam{colourName}{Colour name, which should be in the \helpref{colour database}{wxcolourdatabase}.} + +\docparam{width}{Width of pen.} \docparam{style}{Pen style. See \helpref{wxPen::wxPen}{wxpenconstr} for a list of styles.}