wxWidgets: interface/wx/pen.h File Reference

| Version: 3.0.2

- Main Page
- Related Pages
- Categories
- Classes
- Files

- File List
- File Members

Classes | Enumerations | Variables
pen.h File Reference

## Classes
class | wxPen
| A pen is a drawing tool for drawing outlines. More...
class | wxPenList
| There is only one instance of this class: wxThePenList. More...

## Enumerations
enum | wxPenStyle { wxPENSTYLE_INVALID = -1, wxPENSTYLE_SOLID, wxPENSTYLE_DOT, wxPENSTYLE_LONG_DASH, wxPENSTYLE_SHORT_DASH, wxPENSTYLE_DOT_DASH, wxPENSTYLE_USER_DASH, wxPENSTYLE_TRANSPARENT, wxPENSTYLE_STIPPLE_MASK_OPAQUE, wxPENSTYLE_STIPPLE_MASK, wxPENSTYLE_STIPPLE, wxPENSTYLE_BDIAGONAL_HATCH, wxPENSTYLE_CROSSDIAG_HATCH, wxPENSTYLE_FDIAGONAL_HATCH, wxPENSTYLE_CROSS_HATCH, wxPENSTYLE_HORIZONTAL_HATCH, wxPENSTYLE_VERTICAL_HATCH, wxPENSTYLE_FIRST_HATCH, wxPENSTYLE_LAST_HATCH }
| The possible styles for a wxPen. More...
enum | wxPenJoin { wxJOIN_INVALID = -1, wxJOIN_BEVEL = 120, wxJOIN_MITER, wxJOIN_ROUND }
| The possible join values of a wxPen. More...
enum | wxPenCap { wxCAP_INVALID = -1, wxCAP_ROUND = 130, wxCAP_PROJECTING, wxCAP_BUTT }
| The possible cap values of a wxPen. More...

## Variables
wxPen | wxNullPen
| An empty pen.
wxPen * | wxRED_PEN
| Red pen.
wxPen * | wxBLUE_PEN
| Blue pen.
wxPen * | wxCYAN_PEN
| Cyan pen.
wxPen * | wxGREEN_PEN
| Green pen.
wxPen * | wxYELLOW_PEN
| Yellow pen.
wxPen * | wxBLACK_PEN
| Black pen.
wxPen * | wxWHITE_PEN
| White pen.
wxPen * | wxTRANSPARENT_PEN
| Transparent pen.
wxPen * | wxBLACK_DASHED_PEN
| Black dashed pen.
wxPen * | wxGREY_PEN
| Grey pen.
wxPen * | wxMEDIUM_GREY_PEN
| Medium-grey pen.
wxPen * | wxLIGHT_GREY_PEN
| Light-grey pen.
wxPenList * | wxThePenList
| The global list of wxPen objects ready to be re-used (for better performances).

## Enumeration Type Documentation

enum wxPenCap

The possible cap values of a wxPen.

Todo:
  use wxPENCAP_ prefix

Enumerator:

  wxCAP_INVALID |
  wxCAP_ROUND |
  wxCAP_PROJECTING |
  wxCAP_BUTT |

enum wxPenJoin

The possible join values of a wxPen.

Todo:
  use wxPENJOIN_ prefix

Enumerator:

  wxJOIN_INVALID |
  wxJOIN_BEVEL |
  wxJOIN_MITER |
  wxJOIN_ROUND |

enum wxPenStyle

The possible styles for a wxPen.

Note that hatched pen styles are not supported by X11-based ports, including wxGTK.

Enumerator:

  wxPENSTYLE_INVALID |
  wxPENSTYLE_SOLID | Solid style.
  wxPENSTYLE_DOT | Dotted style.
  wxPENSTYLE_LONG_DASH | Long dashed style.
  wxPENSTYLE_SHORT_DASH | Short dashed style.
  wxPENSTYLE_DOT_DASH | Dot and dash style.
  wxPENSTYLE_USER_DASH | Use the user dashes: see wxPen::SetDashes.
  wxPENSTYLE_TRANSPARENT | No pen is used.
  wxPENSTYLE_STIPPLE_MASK_OPAQUE | Todo: WHAT's this?
  wxPENSTYLE_STIPPLE_MASK | Todo: WHAT's this?
  wxPENSTYLE_STIPPLE | Use the stipple bitmap.
  wxPENSTYLE_BDIAGONAL_HATCH | Backward diagonal hatch.
  wxPENSTYLE_CROSSDIAG_HATCH | Cross-diagonal hatch.
  wxPENSTYLE_FDIAGONAL_HATCH | Forward diagonal hatch.
  wxPENSTYLE_CROSS_HATCH | Cross hatch.
  wxPENSTYLE_HORIZONTAL_HATCH | Horizontal hatch.
  wxPENSTYLE_VERTICAL_HATCH | Vertical hatch.
  wxPENSTYLE_FIRST_HATCH | First of the hatch styles (inclusive).
  wxPENSTYLE_LAST_HATCH | Last of the hatch styles (inclusive).

## Variable Documentation

wxPen* wxBLACK_DASHED_PEN

Black dashed pen.

Except for the color and for the `wxPENSTYLE_SHORT_DASH` it has all standard attributes (1-pixel width, `wxCAP_ROUND` style, etc...).

wxPen* wxBLACK_PEN

Black pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen* wxBLUE_PEN

Blue pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen* wxCYAN_PEN

Cyan pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen* wxGREEN_PEN

Green pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen* wxGREY_PEN

Grey pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen* wxLIGHT_GREY_PEN

Light-grey pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen* wxMEDIUM_GREY_PEN

Medium-grey pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen wxNullPen

An empty pen.

wxPen::IsOk() always returns false for this object.

wxPen* wxRED_PEN

Red pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPenList* wxThePenList

The global list of wxPen objects ready to be re-used (for better performances).

wxPen* wxTRANSPARENT_PEN

Transparent pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen* wxWHITE_PEN

White pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).

wxPen* wxYELLOW_PEN

Yellow pen.

Except for the color it has all standard attributes (1-pixel width, `wxPENSTYLE_SOLID` and `wxCAP_ROUND` styles, etc...).