wx.GridCtrl.Extended.ColourSet2D Class Reference

Inheritance diagram for wx.GridCtrl.Extended.ColourSet2D:

wx.ICanBeMadeReadonly

List of all members.

Public Member Functions

object Clone ()
 ColourSet2D (ColourSet2D src)
 ColourSet2D (Colour fgColour, Colour bgColour, Colour fgColourSelected, Colour bgColourSelected, Colour fgColourPrimSelection, Colour bgColourPrimSelection)
 ColourSet2D ()
override bool Equals (object obj)
override int GetHashCode ()
object MakeReadOnly ()

Properties

wx.Colour Background [get, set]
 
Exceptions:
System.InvalidOperationException Will be thrown by the setter if this is readonly.

wx.Colour BackgroundPrimarySelection [get, set]
wx.Colour BackgroundSelected [get, set]
wx.Colour Foreground [get, set]
 
Exceptions:
System.InvalidOperationException Will be thrown by the setter if this is readonly.

wx.Colour ForegroundPrimarySelection [get, set]
wx.Colour ForegroundSelected [get, set]
bool IsReadonly [get]


Detailed Description

A colour set for those renderers drawing in a simple 2D style. This will distinguish a foreground colour for frame and text. A background colour is intended to be used for the background of the cell.

This set will provide 2 foreground and 2 background colours: One pair of colours for unselected, one pair for selected cells.


Constructor & Destructor Documentation

wx.GridCtrl.Extended.ColourSet2D.ColourSet2D (  ) 

A ctor using the system colours SystemColour.COLOUR_WINDOW, SystemColour.COLOUR_WINDOWTEXT, SystemColour.COLOUR_HIGHLIGHT, and SystemColour.COLOUR_HIGHLIGHTTEXT.

wx.GridCtrl.Extended.ColourSet2D.ColourSet2D ( Colour  fgColour,
Colour  bgColour,
Colour  fgColourSelected,
Colour  bgColourSelected,
Colour  fgColourPrimSelection,
Colour  bgColourPrimSelection 
)

Creates an instance from the provided colours.

Parameters:
fgColour The foreground colour that will for instance be used to display text.
bgColour The background colour.
fgColourSelected The foreground colour of a selected cell.
bgColourSelected The background colour of a selected cell.
fgColourPrimSelection The foreground colour of the primary selection - the cell that will open its editor.
bgColourPrimSelection The background colour of the primary selection - the cell that will open its editor.

wx.GridCtrl.Extended.ColourSet2D.ColourSet2D ( ColourSet2D  src  ) 

This will create a shallow copy of the argument using the same instances for each of the contained colours. This is to prevent excessive use of handles for colours. The new instance is guaranteed to be NOT readonly.

Parameters:
src 


Member Function Documentation

object wx.GridCtrl.Extended.ColourSet2D.Clone (  ) 

This creates a shallow copy of this using the same instances for each of teh contained colours as this instance.

Returns:

override bool wx.GridCtrl.Extended.ColourSet2D.Equals ( object  obj  ) 

override int wx.GridCtrl.Extended.ColourSet2D.GetHashCode (  ) 

object wx.GridCtrl.Extended.ColourSet2D.MakeReadOnly (  ) 

This will make this instance and all property instances of colours readonly.

Returns:
this

Implements wx.ICanBeMadeReadonly.


Property Documentation

wx.Colour wx.GridCtrl.Extended.ColourSet2D.Background [get, set]

Exceptions:
System.InvalidOperationException Will be thrown by the setter if this is readonly.

wx.Colour wx.GridCtrl.Extended.ColourSet2D.BackgroundPrimarySelection [get, set]

Background colour of the primary selection. The primary selection is the cell that will open its editor if requeste e.g. pressing key F2. However, this colour will only used in those modes that allow secondary selections like row or column selection mode or multi-selection modes.

Exceptions:
System.InvalidOperationException Will be thrown by the setter if this is readonly.

wx.Colour wx.GridCtrl.Extended.ColourSet2D.BackgroundSelected [get, set]

Background colour of a selected cell.

Exceptions:
System.InvalidOperationException Will be thrown by the setter if this is readonly.

wx.Colour wx.GridCtrl.Extended.ColourSet2D.Foreground [get, set]

Exceptions:
System.InvalidOperationException Will be thrown by the setter if this is readonly.

wx.Colour wx.GridCtrl.Extended.ColourSet2D.ForegroundPrimarySelection [get, set]

Foreground colour of the primary selection. The primary selection is the cell that will open its editor if requeste e.g. pressing key F2. However, this colour will only used in those modes that allow secondary selections like row or column selection mode or multi-selection modes.

Exceptions:
System.InvalidOperationException Will be thrown by the setter if this is readonly.

wx.Colour wx.GridCtrl.Extended.ColourSet2D.ForegroundSelected [get, set]

Foreground colour of a selected cell.

Exceptions:
System.InvalidOperationException Will be thrown by the setter if this is readonly.

bool wx.GridCtrl.Extended.ColourSet2D.IsReadonly [get]

If this is true, all modifiers will cause exceptions. If this is false, modfiers can be used.

Implements wx.ICanBeMadeReadonly.


Manual of the wx.NET   (c) 2003-2011 the wx.NET project at   Get wx.NET at SourceForge.net. Fast, secure and Free Open Source software downloads