Phoenix Logo

phoenix_title wx.lib.agw.xlsgrid.XLSBorder

This is a class which holds information about a single cell border, in terms of its location (top, left, bottom, right, diagonal), its colour, width and shape.


class_hierarchy Class Hierarchy

Inheritance diagram for class XLSBorder:


method_summary Methods Summary

__init__ Default class constructor.
Draw Actually draws the cell border.
DrawBorder Actually draws the cell border (one of left, right, bottom, top).
DrawDiagonals Actually draws the cell diagonal border.

api Class API



class XLSBorder(object)

This is a class which holds information about a single cell border, in terms of its location (top, left, bottom, right, diagonal), its colour, width and shape.


Methods



__init__(self, location, line_style, border_colour, default_colour, diagonals)

Default class constructor.

Parameters:
  • location – the actual border location (top, left, bottom, right, diagonal);
  • line_style – the line style used by Excel to draw this border;
  • border_colour – the colour used by Excel to draw this border;
  • default_colour – the “magic” colour used by Excel to draw non-custom border lines;
  • diagonals – a tuple containing whether or not to draw the up and down diagonal borders.


Draw(self, dc, rect)

Actually draws the cell border.

Parameters:
  • dc – an instance of wx.DC;
  • rect – an instance of wx.Rect, representing the cell rectangle.


DrawBorder(self, dc, rect)

Actually draws the cell border (one of left, right, bottom, top).

Parameters:
  • dc – an instance of wx.DC;
  • rect – an instance of wx.Rect, representing the cell rectangle.


DrawDiagonals(self, dc, rect)

Actually draws the cell diagonal border.

Parameters:
  • dc – an instance of wx.DC;
  • rect – an instance of wx.Rect, representing the cell rectangle.