MenuBorderStyleFactory¶
-
class
consolemenu.format.
MenuBorderStyleFactory
[source]¶ Factory class for creating MenuBorderStyle instances.
-
create_ascii_border
()[source]¶ Create an ASCII border style.
Returns: a new instance of AsciiBorderStyle. Return type: AsciiBorderStyle
-
create_border
(border_style_type)[source]¶ Create a new MenuBorderStyle instance based on the given border style type.
Parameters: border_style_type (int) – an integer value from MenuBorderStyleType
.Returns: a new MenuBorderStyle instance of the specified style. Return type: MenuBorderStyle
-
create_doubleline_border
()[source]¶ Create a border style using “double-line” box drawing characters.
Returns: a new instance of DoubleLineBorderStyle. Return type: DoubleLineBorderStyle
-
create_doubleline_outer_light_inner_border
()[source]¶ Create a border style using “double-line” box drawing characters for outer border elements, and “light” box drawing characters for inner border elements.
Returns: a new instance of DoubleLineOuterLightInnerBorderStyle Return type: DoubleLineOuterLightInnerBorderStyle
-
create_heavy_border
()[source]¶ Create a border style using “heavy” box drawing characters.
NOTE: The Heavy border style will work on Windows ONLY when using Python 3.6 or later. If on Windows and using an earlier version of Python, the heavy border will be substituted with the DOUBLE_LINE_BORDER.
Returns: a new instance of HeavyBorderStyle, unless on Windows and pre-Python 3.5, in which case a new instance of DoubleLineBorderStyle will be returned. Return type: HeavyBorderStyle
orDoubleLineBorderStyle
-
create_heavy_outer_light_inner_border
()[source]¶ Create a border style using “heavy” box drawing characters for outer border elements, and “light” box drawing characters for inner border elements.
NOTE: The Heavy border style will work on Windows ONLY when using Python 3.6 or later. If on Windows and using an earlier version of Python, the heavy border will be substituted with the DOUBLE_LINE_BORDER.
Returns: a new instance of HeavyOuterLightInnerBorderStyle, unless on Windows and pre-Python 3.5, in which case a new instance of DoubleLineOuterLightInnerBorderStyle will be returned. Return type: HeavyOuterLightInnerBorderStyle
orDoubleLineOuterLightInnerBorderStyle
-