skin.py classes and methods
Search classes
Section titled “Search classes”These are implementation classes, mostly used by the skin engine itself. Their constructors and internal methods are listed for source navigation. For a new plugin screen, inherit from Screens.Screen.Screen, not from a skin parsing context.
Open an entry’s method list to jump to exact source lines. Inherited methods are not duplicated here. Complex list-template and native-stack tutorials are reserved for later units.
10 entries
Source snapshot: skin.py @ f4135659cb. The catalogue lists source capabilities; support also depends on the receiver build and native widget class.
AttributeParser
Dispatches collected XML attribute names to native GUI methods; it is a shared dispatcher, not a guarantee that every widget supports every attribute.
Methods defined in this class (130)
__init__(self, guiObject, desktop, scale=((1, 1), (1, 1)))applyAll(self, attributes)applyOne(self, attribute, value)applyHorizontalScale(self, value)applyVerticalScale(self, value)align(self, value)alphaBlend(self, value)alphaTest(self, value)alphatest(self, value)animationMode(self, value)animationPaused(self, value)backgroundColor(self, value)backgroundColorEven(self, value)backgroundColorOdd(self, value)backgroundColorRows(self, value)backgroundColorSelected(self, value)backgroundGradient(self, value)backgroundGradientSelected(self, value)backgroundPixmap(self, value)base(self, value)borderColor(self, value)borderWidth(self, value)condition(self, value)conditional(self, value)connection(self, value)cornerRadius(self, value)enableWrapAround(self, value)entryFont(self, value)errorCorrection(self, value)excludes(self, value)flags(self, value)font(self, value)fontScale(self, value)foregroundColor(self, value)foregroundColorSelected(self, value)foregroundGradient(self, value)gradientMode(self, value)hAlign(self, value)halign(self, value)headerFont(self, value)headerForegroundColor(self, value)horizontalAlignment(self, value)ignoreWidgets(self, value)includes(self, value)itemAlignment(self, value)itemCornerRadius(self, value)itemCornerRadiusMarked(self, value)itemCornerRadiusMarkedAndSelected(self, value)itemCornerRadiusSelected(self, value)itemGradient(self, value)itemGradientMarked(self, value)itemGradientMarkedAndSelected(self, value)itemGradientSelected(self, value)itemHeight(self, value)itemSpacing(self, value)itemWidth(self, value)label(self, value)layout(self, value)listOrientation(self, value)noWrap(self, value)objectTypes(self, value)orientation(self, value)OverScan(self, value)overScan(self, value)padding(self, value)pixmap(self, value)pointer(self, value)position(self, value)quietZone(self, value)resolution(self, value)scale(self, value)scaleFlags(self, value)scrollbarBackgroundColor(self, value)scrollbarBackgroundGradient(self, value)scrollbarBackgroundPicture(self, value)scrollbarBackgroundPixmap(self, value)scrollbarbackgroundPixmap(self, value)scrollbarBorderColor(self, value)scrollbarBorderWidth(self, value)scrollbarForegroundColor(self, value)scrollbarForegroundGradient(self, value)scrollbarForegroundPixmap(self, value)scrollbarLength(self, value)scrollbarMode(self, value)scrollbarOffset(self, value)scrollbarRadius(self, value)scrollbarScroll(self, value)scrollbarSliderBorderColor(self, value)scrollbarSliderBorderWidth(self, value)scrollbarSliderForegroundColor(self, value)scrollbarSliderPicture(self, value)scrollbarSliderPixmap(self, value)scrollbarWidth(self, value)scrollText(self, value)secondFont(self, value)secondfont(self, value)seek_pointer(self, value)seekPointer(self, value)selection(self, value)selectionDisabled(self, value)selectionPixmap(self, value)selectionZoom(self, value)selectionZoomSize(self, value)separatorLineColor(self, value)separatorLineSize(self, value)shadowColor(self, value)shadowOffset(self, value)size(self, value)sliderPixmap(self, value)spacing(self, value)spacingColor(self, value)stack(self, value)tabWidth(self, value)tag(self, value)text(self, value)textBorderColor(self, value)textBorderWidth(self, value)textOffset(self, value)textPadding(self, value)title(self, value)transparent(self, value)underline(self, value)vAlign(self, value)valign(self, value)valueFont(self, value)verticalAlignment(self, value)widgetBorderColor(self, value)widgetBorderWidth(self, value)wrap(self, value)zPosition(self, value)
additionalWidget
Internal holder for a decorative native widget and its skin attributes.
Methods defined in this class (1)
ComponentTemplates
Stores and retrieves component XML templates and tracks changes.
Methods defined in this class (6)
SizeTuple
Tuple adapter used for already-parsed coordinates while retaining string-like methods expected by skin code.
Methods defined in this class (3)
SkinContext
Layout origin, available size, scale and font context; edge-docked children can consume available space.
Methods defined in this class (3)
SkinContextStack
Layout context that places children without consuming the available parent rectangle.
Methods defined in this class (1)
SkinContextVertical
Context for vertically arranged content and its remaining space.
Methods defined in this class (2)
SkinContextHorizontal
Context for horizontally arranged content and its remaining space.
Methods defined in this class (2)
TemplateParser
Internal parser for list/content XML templates. Listed for discovery; full list-template tutorials belong to a later chapter.
Methods defined in this class (9)
__init__(self, debug=False)resolveColor(self, color)resolvePixmap(self, pixmap)readTemplate(self, templateName)getGradient(self, foregroundGradient, foregroundGradientSelected)collectColors(self, attributes, widgetColors=None)collectAttributes(self, node, context, ignore=(), excludeItemIndexes=None, includeItemIndexes=None)processPanel(self, widget, context, excludeItemIndexes=None, includeItemIndexes=None)processNone(self, widget, context)
SkinError
Skin-processing exception type whose message can include the configured skin context.
Methods defined in this class (2)
No matching entry. Clear the filter or search the whole handbook above.