skin Namespace Reference

Classes
class	AttributeParser
class	additionalWidget
class	SizeTuple
class	SkinContext
class	SkinContextStack
class	SkinError

Functions
def	InitSkins ()
def	loadSkin (filename, scope=SCOPE_SKINS, desktop=getDesktop(GUI_SKIN_ID), screenID=GUI_SKIN_ID)
def	reloadSkins ()
def	addCallback (callback)
def	removeCallback (callback)
def	getParentSize (object, desktop)
def	skinError (errorMessage)
def	attribDeprecationWarning (attribute, replacement)
def	parseOptions (options, attribute, value, default)
def	parseAlphaTest (value)
def	parseAnimationMode (value)
def	parseBoolean (attribute, value)
def	parseColor (value, default=0x00FFFFFF)
def	parseCoordinate (value, parent, size=0, font=None, scale=(1, 1))
def	parseFont (value, scale=((1, 1),(1, 1)))
def	parseHorizontalAlignment (value)
def	parseInteger (value, default=0)
def	parseOrientation (value)
def	parseParameter (value)
def	parsePixmap (path, desktop)
def	parsePosition (value, scale, object=None, desktop=None, size=None)
def	parseSize (value, scale, object=None, desktop=None)
def	parseValuePair (value, scale, object=None, desktop=None, size=None)
def	parseScaleFlags (value)
def	parseScrollbarMode (value)
def	parseScrollbarScroll (value)
def	parseTextPadding (value)
def	parseVerticalAlignment (value)
def	collectAttributes (skinAttributes, node, context, skinPath=None, ignore=(), filenames=frozenset(("pixmap", "pointer", "seekPointer", "seek_pointer", "backgroundPixmap", "selectionPixmap", "sliderPixmap", "scrollbarBackgroundPixmap", "scrollbarForegroundPixmap", "scrollbarbackgroundPixmap", "scrollbarBackgroundPicture", "scrollbarSliderPicture")))
def	applyAllAttributes (guiObject, desktop, attributes, scale=((1, 1),(1, 1)))
def	reloadWindowStyles ()
def	loadSingleSkinData (desktop, screenID, domSkin, pathSkin, scope=SCOPE_GUISKIN)
def	readSkin (screen, skin, names, desktop)
def	findWidgets (name)
def	getScrollLabelStyle (element)
def	getSkinFactor (screen=GUI_SKIN_ID)
def	findSkinScreen (names)
def	dump (x, i=0)

Variables
	MODULE_NAME = __name__.split(".")[-1].capitalize()
string	DEFAULT_SKIN = "MetrixHD/skin.xml"
string	EMERGENCY_SKIN = "skin_default.xml"
string	EMERGENCY_NAME = "Default OE-A"
string	DEFAULT_DISPLAY_SKIN = "skin_display_grautec.xml" if BoxInfo.getItem("grautec") else "skin_display.xml"
string	USER_SKIN = "skin_user.xml"
string	USER_SKIN_TEMPLATE = "skin_user_%s.xml"
string	SUBTITLE_SKIN = "skin_subtitles.xml"
int	GUI_SKIN_ID = 0
int	DISPLAY_SKIN_ID = 2 if BoxInfo.getItem("model").startswith("dm") else 1
dictionary	domScreens = {}
dictionary	colors
dictionary	fonts
dictionary	menus = {}
dictionary	parameters = {}
dictionary	setups = {}
dictionary	switchPixmap = {}
dictionary	windowStyles = {}
dictionary	resolutions = {}
dictionary	scrollLabelStyle = {}
dictionary	constantWidgets = {}
dictionary	variables = {}
bool	isVTISkin = False
	skin = resolveFilename(SCOPE_SKINS, DEFAULT_SKIN)
	primary_skin
	default
	display_skin
	currentPrimarySkin = None
	currentDisplaySkin = None
list	callbacks = []
bool	runCallbacks = False

Function Documentation

addCallback()

def skin.addCallback

(

callback

)

applyAllAttributes()

def skin.applyAllAttributes	(		guiObject,
			desktop,
			attributes,
			scale = ((1, 1), (1, 1))
	)

attribDeprecationWarning()

def skin.attribDeprecationWarning	(		attribute,
			replacement
	)

collectAttributes()

def skin.collectAttributes	(		skinAttributes,
			node,
			context,
			skinPath = None,
			ignore = (),
			filenames = frozenset(("pixmap", "pointer", "seekPointer", "seek_pointer", "backgroundPixmap", "selectionPixmap", "sliderPixmap", "scrollbarBackgroundPixmap", "scrollbarForegroundPixmap", "scrollbarbackgroundPixmap", "scrollbarBackgroundPicture", "scrollbarSliderPicture"))
	)

dump()

def skin.dump	(		x,
			i = 0
	)

findSkinScreen()

def skin.findSkinScreen

(

names

)

findWidgets()

def skin.findWidgets

(

name

)

getParentSize()

def skin.getParentSize	(		object,
			desktop
	)

getScrollLabelStyle()

def skin.getScrollLabelStyle

(

element

)

getSkinFactor()

def skin.getSkinFactor

(

screen = GUI_SKIN_ID

)

InitSkins()

def skin.InitSkins

(

)

loadSingleSkinData()

def skin.loadSingleSkinData	(		desktop,
			screenID,
			domSkin,
			pathSkin,
			scope = SCOPE_GUISKIN
	)

Loads skin data like colors, windowstyle etc.

loadSkin()

def skin.loadSkin	(		filename,
			scope = SCOPE_SKINS,
			desktop = getDesktop(GUI_SKIN_ID),
			screenID = GUI_SKIN_ID
	)

parseAlphaTest()

def skin.parseAlphaTest

(

value

)

parseAnimationMode()

def skin.parseAnimationMode

(

value

)

parseBoolean()

def skin.parseBoolean	(		attribute,
			value
	)

parseColor()

def skin.parseColor	(		value,
			default = 0x00FFFFFF
	)

parseCoordinate()

def skin.parseCoordinate	(		value,
			parent,
			size = 0,
			font = None,
			scale = (1, 1)
	)

parseFont()

def skin.parseFont	(		value,
			scale = ((1, 1), (1, 1))
	)

parseHorizontalAlignment()

def skin.parseHorizontalAlignment

(

value

)

parseInteger()

def skin.parseInteger	(		value,
			default = 0
	)

parseOptions()

def skin.parseOptions	(		options,
			attribute,
			value,
			default
	)

parseOrientation()

def skin.parseOrientation

(

value

)

parseParameter()

def skin.parseParameter

(

value

)

This function is responsible for parsing parameters in the skin, it can parse integers, floats, hex colors, hex integers, named colors, fonts and strings.

parsePixmap()

def skin.parsePixmap	(		path,
			desktop
	)

parsePosition()

def skin.parsePosition	(		value,
			scale,
			object = None,
			desktop = None,
			size = None
	)

parseScaleFlags()

def skin.parseScaleFlags

(

value

)

parseScrollbarMode()

def skin.parseScrollbarMode

(

value

)

parseScrollbarScroll()

def skin.parseScrollbarScroll

(

value

)

parseSize()

def skin.parseSize	(		value,
			scale,
			object = None,
			desktop = None
	)

parseTextPadding()

def skin.parseTextPadding

(

value

)

parseValuePair()

def skin.parseValuePair	(		value,
			scale,
			object = None,
			desktop = None,
			size = None
	)

parseVerticalAlignment()

def skin.parseVerticalAlignment

(

value

)

readSkin()

def skin.readSkin	(		screen,
			skin,
			names,
			desktop
	)

reloadSkins()

def skin.reloadSkins

(

)

reloadWindowStyles()

def skin.reloadWindowStyles

(

)

removeCallback()

def skin.removeCallback

(

callback

)

skinError()

def skin.skinError

(

errorMessage

)

Variable Documentation

callbacks

list skin.callbacks = []

colors

dictionary skin.colors

Initial value:

=  {  # Dictionary of skin color names.
  "key_back": gRGB(0x00313131),
  "key_blue": gRGB(0x0018188B),
  "key_green": gRGB(0x001F771F),
  "key_red": gRGB(0x009F1313),
  "key_text": gRGB(0x00FFFFFF),
  "key_yellow": gRGB(0x00A08500)
}

constantWidgets

dictionary skin.constantWidgets = {}

currentDisplaySkin

skin.currentDisplaySkin = None

currentPrimarySkin

skin.currentPrimarySkin = None

default

skin.default

DEFAULT_DISPLAY_SKIN

string skin.DEFAULT_DISPLAY_SKIN = "skin_display_grautec.xml" if BoxInfo.getItem("grautec") else "skin_display.xml"

DEFAULT_SKIN

string skin.DEFAULT_SKIN = "MetrixHD/skin.xml"

display_skin

skin.display_skin

DISPLAY_SKIN_ID

int skin.DISPLAY_SKIN_ID = 2 if BoxInfo.getItem("model").startswith("dm") else 1

domScreens

dictionary skin.domScreens = {}

EMERGENCY_NAME

string skin.EMERGENCY_NAME = "Default OE-A"

EMERGENCY_SKIN

string skin.EMERGENCY_SKIN = "skin_default.xml"

fonts

dictionary skin.fonts

Initial value:

=  {  # Dictionary of predefined and skin defined font aliases.
  "Body": ("Regular", 18, 22, 16),
  "ChoiceList": ("Regular", 20, 24, 18)
}

GUI_SKIN_ID

int skin.GUI_SKIN_ID = 0

isVTISkin

bool skin.isVTISkin = False

menus

dictionary skin.menus = {}

MODULE_NAME

skin.MODULE_NAME = __name__.split(".")[-1].capitalize()

parameters

dictionary skin.parameters = {}

primary_skin

skin.primary_skin

resolutions

dictionary skin.resolutions = {}

runCallbacks

bool skin.runCallbacks = False

scrollLabelStyle

dictionary skin.scrollLabelStyle = {}

setups

dictionary skin.setups = {}

skin

skin.skin = resolveFilename(SCOPE_SKINS, DEFAULT_SKIN)

SUBTITLE_SKIN

string skin.SUBTITLE_SKIN = "skin_subtitles.xml"

switchPixmap

dictionary skin.switchPixmap = {}

USER_SKIN

string skin.USER_SKIN = "skin_user.xml"

USER_SKIN_TEMPLATE

string skin.USER_SKIN_TEMPLATE = "skin_user_%s.xml"

variables

dictionary skin.variables = {}

windowStyles

dictionary skin.windowStyles = {}