pyxbmct.addonskin

Classes for defining the appearance of PyXBMCt Windows and Controls

Classes

BaseSkin()	Abstract class for creating fully customized skins
Skin()	Skin class

class pyxbmct.addonskin.BaseSkin

Bases: ABC

Abstract class for creating fully customized skins

Warning

This class is meant for subclassing and cannot be instantiated directly! A sublcass must implement all the following properties.

abstract images()

Get the base directory for image files

Return type:

str

abstract x_margin()

Get horizontal adjustment for the header background if the main background has transparent edges.

Return type:

int

abstract y_margin()

Get vertical adjustment for the header background if the main background has transparent edges.

Return type:

int

abstract title_bar_x_shift()

Get horizontal adjustment for title bar texture

Return type:

int

abstract title_bar_y_shift()

Get vertical adjustment for title bar texture

Return type:

int

abstract title_back_y_shift()

Get header position adjustment if the main background has visible borders.

Return type:

int

abstract header_height()

Get the height of a window header (for the title background and the title label).

Return type:

int

abstract close_btn_width()

Get the width of the top-right close button

Return type:

int

abstract close_btn_height()

Get the height of the top-right close button

Return type:

int

abstract close_btn_x_offset()

Get close button horizontal adjustment

Return type:

int

abstract close_btn_y_offset()

Get close button vertical adjustment

Return type:

int

abstract header_align()

Get a numeric value for header text alignment

For example:

• 0: left

• 6: center

Return type:

int

abstract header_text_color()

Get the color of the header text

Return type:

str

abstract background_img()

Get dialog background texture

Return type:

str

abstract title_background_img()

Get title bar background texture

Return type:

str

abstract close_button_focus()

Get close button focused texture

Return type:

str

abstract close_button_no_focus()

Get close button unfocused texture

Return type:

str

abstract main_bg_img()

Get fullscreen background for AddonFullWindow class

Return type:

str

class pyxbmct.addonskin.Skin

Bases: BaseSkin

Skin class

Defines parameters that control the appearance of PyXBMCt windows and controls.

property estuary

Get or set a boolean property that defines the look of PyXBMCt elements:

• True – use Estuary skin appearance

• False – use Confluence skin appearance.

Return type:

bool

property images

Get the base directory for image files

Return type:

str

property x_margin

Get horizontal adjustment for the header background if the main background has transparent edges.

Return type:

int

property y_margin

Get vertical adjustment for the header background if the main background has transparent edges.

Return type:

int

property title_bar_x_shift

Get horizontal adjustment for title bar texture

Return type:

int

property title_bar_y_shift

Get vertical adjustment for title bar texture

Return type:

int

property title_back_y_shift

Get header position adjustment if the main background has visible borders.

Return type:

int

property header_height

Get the height of a window header (for the title background and the title label).

Return type:

int

property close_btn_width

Get the width of the top-right close button

Return type:

int

property close_btn_height

Get the height of the top-right close button

Return type:

int

property close_btn_x_offset

Get close button horizontal adjustment

Return type:

int

property close_btn_y_offset

Get close button vertical adjustment

Return type:

int

property header_align

Get a numeric value for header text alignment

For example:

• 0: left

• 6: center

Return type:

int

property header_text_color

Get the color of the header text

Return type:

str

property background_img

Get dialog background texture

Return type:

str

property title_background_img

Get title bar background texture

Return type:

str

property close_button_focus

Get close button focused texture

Return type:

str

property close_button_no_focus

Get close button unfocused texture

Return type:

str

property main_bg_img

Get fullscreen background for AddonFullWindow class

Return type:

str