Class: Wx::PG::ColourPropertyValue

Inherits:

Object

• Object
• Object
• Wx::PG::ColourPropertyValue

Defined in:

lib/wx/doc/gen/pg/pg_properties.rb

Overview

Note:

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

Because text, background and other colours tend to differ between platforms, SystemColourProperty must be able to select between system colour and, when necessary, to pick a custom one.

SystemColourProperty value makes this possible.

Requires:

• USE_PROPGRID

Instance Method Summary

• #colour_ ⇒ Wx::Colour

  Resulting colour.

• #colour_=(val) ⇒ void

  Resulting colour.

• #init(type, colour) ⇒ void
• #initialize(*args) ⇒ ColourPropertyValue constructor

  A new instance of ColourPropertyValue.

• #type_ ⇒ Integer

  An integer value relating to the colour, and which exact meaning depends on the property with which it is used.

• #type_=(val) ⇒ void

  An integer value relating to the colour, and which exact meaning depends on the property with which it is used.

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::PG::ColourPropertyValue #initialize(v) ⇒ Wx::PG::ColourPropertyValue #initialize(colour) ⇒ Wx::PG::ColourPropertyValue #initialize(type) ⇒ Wx::PG::ColourPropertyValue #initialize(type, colour) ⇒ Wx::PG::ColourPropertyValue

Returns a new instance of ColourPropertyValue.

Overloads:

• #initialize ⇒ Wx::PG::ColourPropertyValue
• #initialize(v) ⇒ Wx::PG::ColourPropertyValue

  Parameters:

  • v (Wx::PG::ColourPropertyValue)
• #initialize(colour) ⇒ Wx::PG::ColourPropertyValue

  Parameters:

  • colour (Wx::Colour, String, Symbol)
• #initialize(type) ⇒ Wx::PG::ColourPropertyValue

  Parameters:

  • type (Integer)
• #initialize(type, colour) ⇒ Wx::PG::ColourPropertyValue

  Parameters:

  • type (Integer)
  • colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 2779

def initialize(*args) end

Instance Method Details

#colour_ ⇒ Wx::Colour

Resulting colour. Should be correct regardless of type.

Returns:

• (Wx::Colour)

# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 2756

def colour_; end

#colour_=(val) ⇒ void

This method returns an undefined value.

Resulting colour. Should be correct regardless of type.

Parameters:

• val (Wx::Colour)

# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 2762

def colour_=(val); end

#init(type, colour) ⇒ void

This method returns an undefined value.

Parameters:

• type (Integer)
• colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 2784

def init(type, colour) end

#type_ ⇒ Integer

An integer value relating to the colour, and which exact meaning depends on the property with which it is used. For SystemColourProperty: Any of SYS_COLOUR_XXX, or any web-colour ( use Wx::PG_TO_WEB_COLOUR macro - (currently unsupported) ), or PG_COLOUR_CUSTOM. For custom colour properties without values array specified: index or PG_COLOUR_CUSTOM For custom colour properties with values array specified: m_arrValues or PG_COLOUR_CUSTOM

Returns:

• (Integer)

# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 2739

def type_; end

#type_=(val) ⇒ void

This method returns an undefined value.

An integer value relating to the colour, and which exact meaning depends on the property with which it is used. For SystemColourProperty: Any of SYS_COLOUR_XXX, or any web-colour ( use Wx::PG_TO_WEB_COLOUR macro - (currently unsupported) ), or PG_COLOUR_CUSTOM. For custom colour properties without values array specified: index or PG_COLOUR_CUSTOM For custom colour properties with values array specified: m_arrValues or PG_COLOUR_CUSTOM

Parameters:

• val (Integer)

# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 2750

def type_=(val); end