Version: 3.1.1

#include <wx/pen.h>

Detailed Description

There is only one instance of this class: wxThePenList.

Use this object to search for a previously created pen of the desired type and create it if not already found. In some windowing systems, the pen may be a scarce resource, so it can pay to reuse old resources if possible. When an application finishes, all pens will be deleted and their resources freed, eliminating the possibility of 'memory leaks'. However, it is best not to rely on this automatic cleanup because it can lead to double deletion in some circumstances.

There are two mechanisms in recent versions of wxWidgets which make the pen list less useful than it once was. Under Windows, scarce resources are cleaned up internally if they are not being used. Also, a referencing counting mechanism applied to all GDI objects means that some sharing of underlying resources is possible. You don't have to keep track of pointers, working out when it is safe delete a pen, because the referencing counting does it for you. For example, you can set a pen in a device context, and then immediately delete the pen you passed, because the pen is 'copied'.

So you may find it easier to ignore the pen list, and instead create and copy pens as you see fit. If your Windows resource meter suggests your application is using too many resources, you can resort to using GDI lists to share objects explicitly.

The only compelling use for the pen list is for wxWidgets to keep track of pens in order to clean them up on exit. It is also kept for backward compatibility with earlier versions of wxWidgets.

Library:  wxCore
Category:  Graphics Device Interface (GDI)

Predefined objects/pointers: wxThePenList

See also
wxPen

Public Member Functions

 wxPenList ()
 Constructor. More...
 
wxPenFindOrCreatePen (const wxColour &colour, int width=1, wxPenStyle style=wxPENSTYLE_SOLID)
 Finds a pen with the specified attributes and returns it, else creates a new pen, adds it to the pen list, and returns it. More...
 

Constructor & Destructor Documentation

wxPenList::wxPenList ( )

Constructor.

The application should not construct its own pen list: use the object pointer wxThePenList.

Member Function Documentation

wxPen* wxPenList::FindOrCreatePen ( const wxColour colour,
int  width = 1,
wxPenStyle  style = wxPENSTYLE_SOLID 
)

Finds a pen with the specified attributes and returns it, else creates a new pen, adds it to the pen list, and returns it.

Parameters
colourColour object.
widthWidth of pen.
stylePen style. See wxPenStyle for a list of styles.