Class: Wx::PenInfo

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

Overview

Note:

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

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

For instance, to create a dotted blue pen with the given join style you could do

pen = Wx::Pen.new(Wx::PenInfo.new(Wx::BLUE).style(Wx::PENSTYLE_DOT).join(Wx::JOIN_BEVEL))

Instance Method Summary collapse

Constructor Details

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

Parameters:

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


433
 
# File 'lib/wx/doc/gen/pen.rb', line 433

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

Instance Method Details

#cap(cap) ⇒ Wx::PenInfo

Parameters:

Returns:



457
 
# File 'lib/wx/doc/gen/pen.rb', line 457

def cap(cap) end

#colour(col) ⇒ Wx::PenInfo

Parameters:

Returns:



437
 
# File 'lib/wx/doc/gen/pen.rb', line 437

def colour(col) end

#get_cap ⇒ Wx::PenCap

Returns:



492
 
# File 'lib/wx/doc/gen/pen.rb', line 492

def get_cap; end

#get_colour ⇒ Wx::Colour

Returns:



480
 
# File 'lib/wx/doc/gen/pen.rb', line 480

def get_colour; end

#get_dash_count ⇒ Integer Also known as: dash_count

Returns:

  • (Integer) 


498
 
# File 'lib/wx/doc/gen/pen.rb', line 498

def get_dash_count; end

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

Returns:

  • (Array<Integer>) 


44
 
# File 'lib/wx/doc/pen.rb', line 44

def get_dashes; end

#get_join ⇒ Wx::PenJoin

Returns:



489
 
# File 'lib/wx/doc/gen/pen.rb', line 489

def get_join; end

#get_quality ⇒ Wx::PenQuality

Returns:



495
 
# File 'lib/wx/doc/gen/pen.rb', line 495

def get_quality; end

#get_stipple ⇒ Wx::Bitmap

Returns:



483
 
# File 'lib/wx/doc/gen/pen.rb', line 483

def get_stipple; end

#get_style ⇒ Wx::PenStyle

Returns:



486
 
# File 'lib/wx/doc/gen/pen.rb', line 486

def get_style; end

#get_width ⇒ Integer

Returns:

  • (Integer) 


506
 
# File 'lib/wx/doc/gen/pen.rb', line 506

def get_width; end

#high_quality ⇒ Wx::PenInfo

Set high pen quality.

This is the same as calling #quality with Wx::PenQuality::PEN_QUALITY_HIGH.

Returns:



477
 
# File 'lib/wx/doc/gen/pen.rb', line 477

def high_quality; end

#is_transparent ⇒ Boolean Also known as: transparent?

Returns:

  • (Boolean) 


502
 
# File 'lib/wx/doc/gen/pen.rb', line 502

def is_transparent; end

#join(join) ⇒ Wx::PenInfo

Parameters:

Returns:



453
 
# File 'lib/wx/doc/gen/pen.rb', line 453

def join(join) end

#low_quality ⇒ Wx::PenInfo

Set low pen quality.

This is the same as calling #quality with Wx::PenQuality::PEN_QUALITY_LOW.

Returns:



471
 
# File 'lib/wx/doc/gen/pen.rb', line 471

def low_quality; end

#quality(quality) ⇒ Wx::PenInfo

Set the pen quality.

Using #low_quality or #high_quality is usually more convenient.

Parameters:

Returns:

See Also:



465
 
# File 'lib/wx/doc/gen/pen.rb', line 465

def quality(quality) end

#stipple(stipple) ⇒ Wx::PenInfo

Parameters:

Returns:



449
 
# File 'lib/wx/doc/gen/pen.rb', line 449

def stipple(stipple) end

#style(style) ⇒ Wx::PenInfo

Parameters:

Returns:



445
 
# File 'lib/wx/doc/gen/pen.rb', line 445

def style(style) end

#width(width) ⇒ Wx::PenInfo

Parameters:

  • width (Integer)

Returns:



441
 
# File 'lib/wx/doc/gen/pen.rb', line 441

def width(width) end