Class: Wx::GraphicsPenInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/graphics_context.rb,
lib/wx/doc/graphics_context.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

This class is a helper used for GraphicsPen creation using the named parameter idiom: it allows specifying various GraphicsPen attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to GraphicsPen constructors.

Typically, you would use GraphicsPenInfo with a GraphicsContext. For example, to start drawing with a dotted blue pen slightly wider than normal you could, write the following:

ctx = Wx::GraphicsContext.create(dc)

  ctx.set_pen(Wx::GraphicsPenInfo.new(Wx::BLUE).width(1.25).style(Wx::PENSTYLE_DOT))

Requires:

  • USE_GRAPHICS_CONTEXT

Instance Method Summary collapse

Constructor Details

#initialize(colour = (Wx::Colour.new()), width = 1.0, style = Wx::PenStyle::PENSTYLE_SOLID) ⇒ Wx::GraphicsPenInfo

Constructor, which can set the colour, width and style for the pen.

Parameters:

  • colour (Wx::Colour, String, Symbol) (defaults to: (Wx::Colour.new()))
  • width (Float) (defaults to: 1.0)
  • style (Wx::PenStyle) (defaults to: Wx::PenStyle::PENSTYLE_SOLID) 


990
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 990

def initialize(colour=(Wx::Colour.new()), width=1.0, style=Wx::PenStyle::PENSTYLE_SOLID) end

Instance Method Details

#cap(cap) ⇒ Wx::GraphicsPenInfo

Sets the cap (i.e., the end point) for the pen.

Parameters:

Returns:



1022
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1022

def cap(cap) end

#colour(col) ⇒ Wx::GraphicsPenInfo

Sets the colour for the pen.

Parameters:

Returns:



995
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 995

def colour(col) end

#get_cap ⇒ Wx::PenCap

Returns the pen’s cap (i.e., end-point style).

Returns:



1110
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1110

def get_cap; end

#get_colour ⇒ Wx::Colour

Returns the pen’s colour.

Returns:



1094
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1094

def get_colour; end

#get_dash_count ⇒ Integer Also known as: dash_count

Returns the number of dashes in the pen’s dash pattern.

Returns:

  • (Integer) 


1114
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1114

def get_dash_count; end

#get_dashes ⇒ Array<Integer> Also known as: dashes

Returns:

  • (Array<Integer>) 


76
 
# File 'lib/wx/doc/graphics_context.rb', line 76

def get_dashes; end

#get_end_x ⇒ Float Also known as: end_x

Returns the x coordinate of the ending point (if using a gradient).

Returns:

  • (Float) 


1163
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1163

def get_end_x; end

#get_end_y ⇒ Float Also known as: end_y

Returns the y coordinate of the ending point (if using a gradient).

Returns:

  • (Float) 


1168
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1168

def get_end_y; end

#get_gradient_type ⇒ Wx::GradientType Also known as: gradient_type

Returns the pen’s gradient type.

Returns:



1128
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1128

def get_gradient_type; end

#get_join ⇒ Wx::PenJoin

Returns the pen’s joining method.

Returns:



1106
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1106

def get_join; end

#get_radius ⇒ Float Also known as: radius

Returns the radius of the radial gradient.

Returns:

  • (Float) 


1173
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1173

def get_radius; end

#get_start_x ⇒ Float Also known as: start_x

Returns the x coordinate of the starting point (if using a gradient).

Returns:

  • (Float) 


1153
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1153

def get_start_x; end

#get_start_y ⇒ Float Also known as: start_y

Returns the y coordinate of the starting point (if using a gradient).

Returns:

  • (Float) 


1158
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1158

def get_start_y; end

#get_stipple ⇒ Wx::Bitmap

Returns the pen’s stipple bitmap.

Returns:



1098
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1098

def get_stipple; end

#get_stops ⇒ Wx::GraphicsGradientStops Also known as: stops

Returns the stops of the gradient.

Returns:



1178
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1178

def get_stops; end

#get_style ⇒ Wx::PenStyle

Returns the pen’s style.

Returns:



1102
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1102

def get_style; end

#get_width ⇒ Float

Returns the pen’s line width.

Returns:

  • (Float) 


1124
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1124

def get_width; end

#get_x1 ⇒ Float Also known as: x1

Returns the x coordinate of the starting point (if using a gradient).

Returns:

  • (Float) 


1133
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1133

def get_x1; end

#get_x2 ⇒ Float Also known as: x2

Returns the x coordinate of the ending point (if using a gradient).

Returns:

  • (Float) 


1143
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1143

def get_x2; end

#get_y1 ⇒ Float Also known as: y1

Returns the y coordinate of the starting point (if using a gradient).

Returns:

  • (Float) 


1138
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1138

def get_y1; end

#get_y2 ⇒ Float Also known as: y2

Returns the y coordinate of the ending point (if using a gradient).

Returns:

  • (Float) 


1148
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1148

def get_y2; end

#is_transparent ⇒ Boolean Also known as: transparent?

Returns whether the pen is transparent.

Returns:

  • (Boolean) 


1119
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1119

def is_transparent; end

#join(join) ⇒ Wx::GraphicsPenInfo

Sets the join for the pen, which is the appearance of where two lines meet or overlap.

Parameters:

Returns:



1017
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1017

def join(join) end

#linear_gradient(x1, y1, x2, y2, c1, c2, matrix = Wx::NULL_GRAPHICS_MATRIX) ⇒ Wx::GraphicsPenInfo #linear_gradient(x1, y1, x2, y2, stops, matrix = Wx::NULL_GRAPHICS_MATRIX) ⇒ Wx::GraphicsPenInfo

Overloads:

  • #linear_gradient(x1, y1, x2, y2, c1, c2, matrix = Wx::NULL_GRAPHICS_MATRIX) ⇒ Wx::GraphicsPenInfo

    Applies a linear gradient to the pen.

    Remark:

    The starting and ending coordinates define the direction of the gradient. Along with north, south, east and west, diagonal directions can also be used.

    Parameters:

    • x1 (Float) —

      The x coordinate of the starting point of the gradient.

    • y1 (Float) —

      The y coordinate of the starting point of the gradient.

    • x2 (Float) —

      The x coordinate of the ending point of the gradient.

    • y2 (Float) —

      The y coordinate of the ending point of the gradient.

    • c1 (Wx::Colour, String, Symbol) —

      The starting colour.

    • c2 (Wx::Colour, String, Symbol) —

      The ending colour.

    • matrix (Wx::GraphicsMatrix) (defaults to: Wx::NULL_GRAPHICS_MATRIX) —

      An optional transformation to apply to the gradient.

    Returns:

  • #linear_gradient(x1, y1, x2, y2, stops, matrix = Wx::NULL_GRAPHICS_MATRIX) ⇒ Wx::GraphicsPenInfo

    Applies a linear gradient to the pen, including discontinuous stops in the pattern.

    Remark:

    The starting and ending coordinates define the direction of the gradient. Along with north, south, east and west, diagonal directions can also be used.

    Parameters:

    • x1 (Float) —

      The x coordinate of the starting point of the gradient.

    • y1 (Float) —

      The y coordinate of the starting point of the gradient.

    • x2 (Float) —

      The x coordinate of the ending point of the gradient.

    • y2 (Float) —

      The y coordinate of the ending point of the gradient.

    • stops (Wx::GraphicsGradientStops) —

      A series of stops to include in the pattern.

    • matrix (Wx::GraphicsMatrix) (defaults to: Wx::NULL_GRAPHICS_MATRIX) —

      An optional transformation to apply to the gradient.

    Returns:



1055
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1055

def linear_gradient(*args) end

#radial_gradient(startX, startY, endX, endY, radius, oColor, cColor, matrix = Wx::NULL_GRAPHICS_MATRIX) ⇒ Wx::GraphicsPenInfo #radial_gradient(startX, startY, endX, endY, radius, stops, matrix = Wx::NULL_GRAPHICS_MATRIX) ⇒ Wx::GraphicsPenInfo

Overloads:

  • #radial_gradient(startX, startY, endX, endY, radius, oColor, cColor, matrix = Wx::NULL_GRAPHICS_MATRIX) ⇒ Wx::GraphicsPenInfo

    Applies a radial (i.e., circular) gradient to the pen.

    Remark:

    The starting and ending coordinates define the direction of the gradient. Along with north, south, east and west, diagonal directions can also be used.

    Parameters:

    • startX (Float) —

      The x coordinate of the starting point of the gradient.

    • startY (Float) —

      The startY coordinate of the starting point of the gradient.

    • endX (Float) —

      The endX coordinate of the end of the circle.

    • endY (Float) —

      The endY coordinate of the end of the circle.

    • radius (Float) —

      The radius of the circle of the gradient (around endX and endY).

    • oColor (Wx::Colour, String, Symbol) —

      The outer colour.

    • cColor (Wx::Colour, String, Symbol) —

      The center colour.

    • matrix (Wx::GraphicsMatrix) (defaults to: Wx::NULL_GRAPHICS_MATRIX) —

      An optional transformation to apply to the gradient.

    Returns:

  • #radial_gradient(startX, startY, endX, endY, radius, stops, matrix = Wx::NULL_GRAPHICS_MATRIX) ⇒ Wx::GraphicsPenInfo

    Applies a radial (i.e., circular) gradient to the pen, including discontinuous stops in the pattern.

    Remark:

    The starting and ending coordinates define the direction of the gradient. Along with north, south, east and west, diagonal directions can also be used.

    Parameters:

    • startX (Float) —

      The x coordinate of the starting point of the gradient.

    • startY (Float) —

      The startY coordinate of the starting point of the gradient.

    • endX (Float) —

      The endX coordinate of the end of the circle.

    • endY (Float) —

      The endY coordinate of the end of the circle.

    • radius (Float) —

      The radius of the circle of the gradient (around endX and endY).

    • stops (Wx::GraphicsGradientStops) —

      A series of stops to include in the pattern.

    • matrix (Wx::GraphicsMatrix) (defaults to: Wx::NULL_GRAPHICS_MATRIX) —

      An optional transformation to apply to the gradient.

    Returns:



1090
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1090

def radial_gradient(*args) end

#stipple(stipple) ⇒ Wx::GraphicsPenInfo

Sets the bitmap used for stippling.

When the pen is used, a repeating pattern of this bitmap will be drawn.

Parameters:

Returns:



1012
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1012

def stipple(stipple) end

#style(style) ⇒ Wx::GraphicsPenInfo

Sets the style for the pen.

Parameters:

Returns:



1005
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1005

def style(style) end

#width(width) ⇒ Wx::GraphicsPenInfo

Sets the line width for the pen.

Parameters:

  • width (Float)

Returns:



1000
 
# File 'lib/wx/doc/gen/graphics_context.rb', line 1000

def width(width) end