Attributes per native widget
A <widget> has no universal fixed set of visual attributes. Its Python component or renderer chooses a native class, and that class determines which setters exist. This reference lists the current central AttributeParser names for each of the 16 native widget classes in the source snapshot, including inherited setters. Deprecated names and compatibility spellings are listed separately.
The counts below are computed from the current-name list. They describe recognised attribute names, not independent visual features. backgroundColor counts once even when it accepts both a solid colour and a gradient. Native setter existence is a dispatch check; each linked entry also explains XML conversion and content requirements.
Find the widget behind the XML
Abschnitt betitelt „Find the widget behind the XML“| Your XML | Where to look |
|---|---|
<eLabel … /> |
eLabel below |
<ePixmap … /> |
ePixmap below |
<eRectangle … /> |
eRectangle below |
<widget source="…" render="Label" … /> |
Label renderer, then eLabel |
<widget source="…" render="Progress" … /> |
Progress renderer, then eSlider |
<widget name="…" … /> |
The screen’s Python assignment, then GUI components |
<screen …> |
eWindow for central visual attributes; readSkin also consumes screen structure |
name, source, render, addon and converter type belong to XML construction, so they do not appear in these counts. The API overview explains that stage. layout on an eStack is another structural setting: the loader selects its horizontal/vertical layout before applying the remaining attributes.
How to read the tables
Abschnitt betitelt „How to read the tables“Each row gives the meaning, a link to the value parser and the actual native setter. Only the listed value variants are supported. A label accepts a solid foregroundColor; it has no setForegroundGradient. A slider accepts both. A recognised method does not guarantee that content is present or that a renderer leaves the value unchanged after the next update.
Use listOrientation on a native listbox and orientation on a slider. Both classes have a method called setOrientation, but the enums and argument counts differ. Component-specific parsers can deliberately reuse a name: an addon with its own orientation handler follows that addon’s API.
The count excludes no-op AttributeParser handlers such as condition, layout and animationPaused. Some are interpreted earlier; others have no visual effect. It also excludes extra options consumed by Python, such as a Pixmap renderer’s pixmaps or RunningText’s options. Consult the renderer API or named-component API for those.
Widget catalogue
Abschnitt betitelt „Widget catalogue“16 entries
Source snapshot f4135659cb. Current attribute counts exclude legacy names and structural XML names. Deprecated attributes and compatibility migrations have their own reference.
eButton
Native button derived from eLabel. It inherits the label attributes. Remote-control actions are connected in Python, not by a skin attribute.
30 current central XML attribute names. Inherits eLabel. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (30)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
alphaTest | Pixmap transparency: off, on (alpha test), or blend (smooth alpha blending). For eLabel and its subclasses, both on and blend enable text blending: setAlphatest maps any positive mode to the same boolean. The three-way pixmap distinction does not apply here. Case-sensitive options: on, off, blend. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. Inherited eLabel override: text outline, not the widget rectangle. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Inherited eLabel override: text outline, not the widget rectangle. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
font | Registered font face or alias and size, for example Regular;28. It is not a font file path. Registered font face or alias, optionally followed by ;size. A numeric size is scaled vertically with the screen. Register the face before using it. | standard syntax: |
fontScale | Automatic label font adjustment: size;offset or width;offset (default offset -4). size;offset or width;offset. Offset is an integer; omitted offset is -4. An offset of 0 does not call the setter. | standard syntax: |
foregroundColor | Text/foreground colour. A gradient value is supported only by the slider foreground path. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: |
horizontalAlignment | Text alignment inside its rectangle: left, center, right or block. Case-sensitive options: left, center, right, block. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
scrollText | Scrolling text configuration as comma-separated key=value pairs; direction, delays, repeat, stepSize and mode. Comma-separated key=value pairs. direction: left/right/top/bottom; stepDelay, startDelay, endDelay: milliseconds; stepSize: pixels; repeat: integer; mode: cached/bounce/bounceCached/roll. Omitted sub-options start at stepDelay=100, startDelay=0, endDelay=0, repeat=0, stepSize=2; omit mode for normal scrolling. | standard syntax: |
shadowColor | Colour of the label text shadow. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
shadowOffset | x,y offset of the text shadow; scaled with the screen. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tabWidth | Tab-stop width for supporting text widgets; auto uses the automatic width. Non-negative integer tab-stop width, or auto for automatic sizing. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
text | Static text, translated before setText. Python or a renderer may replace it later. XML text string; escape & as & and < as <. Translated and set initially; renderer/Python updates can replace it. | standard syntax: |
textBorderColor | Explicit colour of the outline around glyphs; different from a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
textBorderWidth | Explicit glyph-outline thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
underline | Enable or disable underlined label text. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
verticalAlignment | Text alignment inside the widget: top, center/middle or bottom. Case-sensitive options: top, center, middle, bottom. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
wrap | Text overflow mode: wrap, noWrap or ellipsis; current parser also accepts numeric strings. Case-sensitive options: ellipsis, noWrap, wrap. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (73)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvoid setBorderWidth(int width) override— eLabelvoid setBorderColor(const gRGB& col) override— eLabelvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setText(const std::string& string)— eLabelvoid setMarkedPos(int markedPos)— eLabelvoid setFont(gFont* font)— eLabelgFont* getFont()— eLabelvoid setVAlign(int align)— eLabelvoid setHAlign(int align)— eLabelvoid setForegroundColor(const gRGB& col)— eLabelvoid setShadowColor(const gRGB& col)— eLabelvoid setShadowOffset(const ePoint& offset)— eLabelvoid setTextBorderColor(const gRGB& col)— eLabelvoid setTextBorderWidth(int width)— eLabelvoid setWrap(int wrap)— eLabelvoid setNoWrap(int nowrap)— eLabelvoid setUnderline(bool underline)— eLabelvoid setScrollText(int direction, long delay, long startDelay, long endDelay, int repeat, int stepSize, int mode)— eLabelvoid clearForegroundColor()— eLabelint getWrap() const— eLabelint getNoWrap() const— eLabelvoid setAlphatest(int alphatest)— eLabelvoid setTabWidth(int width)— eLabelgRGB getForegroundColor(int styleID = 0)— eLabeleSize calculateSize()— eLabelstatic eSize calculateTextSize(gFont* font, const std::string& string, eSize targetSize, bool nowrap = false)— eLabelvoid setFontScale(int scaleType, int size)— eLabelvoid push()— eButton
eCanvas
Pixmap-derived drawing surface. A Canvas renderer consumes drawing instructions; font and text for those instructions are not eCanvas XML attributes.
18 current central XML attribute names. Inherits ePixmap. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (18)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
alphaTest | Pixmap transparency: off, on (alpha test), or blend (smooth alpha blending). Case-sensitive options: on, off, blend. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
pixmap | Resolved image path passed to LoadPixmap; PNG transparency is commonly used. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
scale | Pixmap scaling flags, for example none, scale, keepAspect or centerScaled. Not screen resolution scaling. Case-sensitive options: none, 0, scale, 1, keepAspect, leftTop, leftCenter, leftMiddle, leftBottom, centerTop, middleTop, centerScaled, middleScaled, centerBottom, middleBottom, rightTop, rightCenter, rightMiddle, rightBottom, moveLeftTop, moveLeftCenter, moveLeftMiddle, moveLeftBottom, moveCenterTop, moveMiddleTop, moveCenter, moveMiddle, moveCenterBottom, moveMiddleBottom, moveRightTop, moveRightCenter, moveRightMiddle, moveRightBottom, off, on, aspect, center, width, height, stretch, fill. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (64)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setPixmap(gPixmap* pixmap)— ePixmapvoid setPixmapFromFile(const char* filename, bool autoDetect = false)— ePixmapvoid setAlphatest(int alphatest)— ePixmapvoid setScale(int scale)— ePixmapvoid setPixmapScale(int flags)— ePixmapvoid setPixmapScaleFlags(int flags)— ePixmapvoid setAniPixmapFromFile(const char* filename, bool autostart = false)— ePixmapvoid startAnimation(bool once = false)— ePixmapvoid stopAnimation()— ePixmapeSize getPixmapSize() const— ePixmapvoid setSize(eSize size)— eCanvasvoid clear(gRGB color)— eCanvasvoid fillRect(eRect rect, gRGB color)— eCanvasvoid drawLine(int x0, int y0, int x1, int y1, gRGB color)— eCanvasvoid writeText(eRect where, gRGB fg, gRGB bg, gFont *font, const char *string, int flags)— eCanvasvoid drawRotatedLine(int ox, int oy, int x0, int y0, int x1, int y1, float angle, bool cw, gRGB color)— eCanvas
eGauge
Native analogue gauge used by clock renderers. The Python renderer supplies values; the XML parser supplies geometry and the supported image attributes.
15 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (15)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (49)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvoid setBorderColor(const gRGB &color)— eGaugevirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setValue(int val)— eGauge
eInput
Native input widget. This is distinct from the commonly used Python Components.Input.Input, whose createWidget returns eLabel. Look up the actual component before selecting attributes.
16 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (16)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
font | Registered font face or alias and size, for example Regular;28. It is not a font file path. Registered font face or alias, optionally followed by ;size. A numeric size is scaled vertically with the screen. Register the face before using it. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (51)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setContent(eInputContent *cnt)— eInputvoid setOverwriteMode(int o)— eInputvoid setFont(gFont *font)— eInput
eLabel
Text label with font, alignment, wrapping, outline, shadow and text scrolling. borderColor/borderWidth address the text outline; use widgetBorderColor/widgetBorderWidth for the rectangular widget border.
30 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (30)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
alphaTest | Pixmap transparency: off, on (alpha test), or blend (smooth alpha blending). For eLabel and its subclasses, both on and blend enable text blending: setAlphatest maps any positive mode to the same boolean. The three-way pixmap distinction does not apply here. Case-sensitive options: on, off, blend. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. Overrides the base implementation: colours the text outline. widgetBorderColor colours the widget rectangle. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Overrides the base implementation: text outline width. widgetBorderWidth sets the widget rectangle border. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
font | Registered font face or alias and size, for example Regular;28. It is not a font file path. Registered font face or alias, optionally followed by ;size. A numeric size is scaled vertically with the screen. Register the face before using it. | standard syntax: |
fontScale | Automatic label font adjustment: size;offset or width;offset (default offset -4). size;offset or width;offset. Offset is an integer; omitted offset is -4. An offset of 0 does not call the setter. | standard syntax: |
foregroundColor | Text/foreground colour. A gradient value is supported only by the slider foreground path. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: |
horizontalAlignment | Text alignment inside its rectangle: left, center, right or block. Case-sensitive options: left, center, right, block. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
scrollText | Scrolling text configuration as comma-separated key=value pairs; direction, delays, repeat, stepSize and mode. Comma-separated key=value pairs. direction: left/right/top/bottom; stepDelay, startDelay, endDelay: milliseconds; stepSize: pixels; repeat: integer; mode: cached/bounce/bounceCached/roll. Omitted sub-options start at stepDelay=100, startDelay=0, endDelay=0, repeat=0, stepSize=2; omit mode for normal scrolling. | standard syntax: |
shadowColor | Colour of the label text shadow. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
shadowOffset | x,y offset of the text shadow; scaled with the screen. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tabWidth | Tab-stop width for supporting text widgets; auto uses the automatic width. Non-negative integer tab-stop width, or auto for automatic sizing. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
text | Static text, translated before setText. Python or a renderer may replace it later. XML text string; escape & as & and < as <. Translated and set initially; renderer/Python updates can replace it. | standard syntax: |
textBorderColor | Explicit colour of the outline around glyphs; different from a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
textBorderWidth | Explicit glyph-outline thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
underline | Enable or disable underlined label text. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
verticalAlignment | Text alignment inside the widget: top, center/middle or bottom. Case-sensitive options: top, center, middle, bottom. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
wrap | Text overflow mode: wrap, noWrap or ellipsis; current parser also accepts numeric strings. Case-sensitive options: ellipsis, noWrap, wrap. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (72)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvoid setBorderWidth(int width) override— eLabelvoid setBorderColor(const gRGB& col) override— eLabelvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setText(const std::string& string)— eLabelvoid setMarkedPos(int markedPos)— eLabelvoid setFont(gFont* font)— eLabelgFont* getFont()— eLabelvoid setVAlign(int align)— eLabelvoid setHAlign(int align)— eLabelvoid setForegroundColor(const gRGB& col)— eLabelvoid setShadowColor(const gRGB& col)— eLabelvoid setShadowOffset(const ePoint& offset)— eLabelvoid setTextBorderColor(const gRGB& col)— eLabelvoid setTextBorderWidth(int width)— eLabelvoid setWrap(int wrap)— eLabelvoid setNoWrap(int nowrap)— eLabelvoid setUnderline(bool underline)— eLabelvoid setScrollText(int direction, long delay, long startDelay, long endDelay, int repeat, int stepSize, int mode)— eLabelvoid clearForegroundColor()— eLabelint getWrap() const— eLabelint getNoWrap() const— eLabelvoid setAlphatest(int alphatest)— eLabelvoid setTabWidth(int width)— eLabelgRGB getForegroundColor(int styleID = 0)— eLabeleSize calculateSize()— eLabelstatic eSize calculateTextSize(gFont* font, const std::string& string, eSize targetSize, bool nowrap = false)— eLabelvoid setFontScale(int scaleType, int size)— eLabel
eListbox
List viewport and selection control. Row content may be string, configuration, service or MultiContent data. Row-template attributes and component-specific attributes are additional contracts.
lib/gui/elistbox.h, line 155 ↗
63 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (63)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorEven | Solid colour for alternating even list rows; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
backgroundColorSelected | Selected row background, as solid colour or a gradient specification. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: |
backgroundPixmap | Background image for a native target implementing setBackgroundPixmap; not universal to all widgets. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
enableWrapAround | Allow list navigation to wrap from the final entry to the first and back. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
entryFont | Font for configuration entry labels on native targets supporting it. Registered font face or alias, optionally followed by ;size. A numeric size is scaled vertically with the screen. Register the face before using it. | standard syntax: |
font | Registered font face or alias and size, for example Regular;28. It is not a font file path. Registered font face or alias, optionally followed by ;size. A numeric size is scaled vertically with the screen. Register the face before using it. | standard syntax: |
fontScale | Automatic label font adjustment: size;offset or width;offset (default offset -4). size;offset or width;offset. Offset is an integer; omitted offset is -4. An offset of 0 does not call the setter. | standard syntax: |
foregroundColor | Text/foreground colour. A gradient value is supported only by the slider foreground path. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: |
foregroundColorSelected | Foreground/text colour for selected list entries. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
headerFont | Font for configuration/list headers on supporting targets. Registered font face or alias, optionally followed by ;size. A numeric size is scaled vertically with the screen. Register the face before using it. | standard syntax: |
headerForegroundColor | Foreground colour of configuration/list headers. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
horizontalAlignment | Text alignment inside its rectangle: left, center, right or block. Case-sensitive options: left, center, right, block. | standard syntax: |
itemAlignment | Align list items within the available list rectangle; distinct from text alignment. Case-sensitive options: default, center, justify, leftTop, leftMiddle, leftBottom, rightTop, rightMiddle, rightBottom, centerTop, centerMiddle, centerBottom, justifyTop, justifyMiddle, justifyBottom, justifyLeft, justifyRight. | standard syntax: |
itemCornerRadius | Rounded item background in its normal state. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
itemCornerRadiusMarked | Rounded background for a marked item. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
itemCornerRadiusSelected | Rounded background of the selected item. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
itemGradient | Background gradient for a normal list item. startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. | standard syntax: |
itemGradientMarked | Background gradient for a marked item. startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. | standard syntax: |
itemGradientSelected | Background gradient for the selected list item. startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. | standard syntax: |
itemHeight | Height of one list entry, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
itemSpacing | Horizontal and vertical gap between list items; one value applies to both axes. One integer for both directions, or horizontal,vertical gap in design pixels. Both axes scale with the screen. | standard syntax: |
itemWidth | Width of one list item, scaled horizontally. Integer design pixels, scaled horizontally with the screen. Use a non-negative value. | standard syntax: |
listOrientation | List layout: vertical, horizontal or grid; not a slider direction. Case-sensitive options: vertical, horizontal, grid. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
scrollbarBackgroundColor | Solid colour behind the scrollbar handle. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
scrollbarBackgroundGradient | Gradient behind the scrollbar handle on supporting targets. startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. | standard syntax: |
scrollbarBackgroundPixmap | Image behind the scrollbar handle. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
scrollbarBorderColor | Scrollbar border colour. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
scrollbarBorderWidth | Scrollbar border thickness, scaled horizontally. Integer design pixels, scaled horizontally with the screen. Use a non-negative value. | standard syntax: |
scrollbarForegroundColor | Scrollbar handle colour. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
scrollbarForegroundGradient | Scrollbar handle gradient. startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. | standard syntax: |
scrollbarForegroundPixmap | Scrollbar handle image. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
scrollbarLength | Scrollbar length: numeric value, full or auto; interpretation is the target widget's. Non-negative integer length, full (0) or auto (-1). On eListbox this sizes the scrollbar track along the list: full uses the widget extent; auto follows the laid-out item extent and offsets. It does not directly set the handle length. | standard syntax: |
scrollbarMode | Visibility and side of the scrollbar; showOnDemand, showAlways, showNever and side-specific modes. Case-sensitive options: showOnDemand, showAlways, showNever, showLeftOnDemand, showLeftAlways, showTopOnDemand, showTopAlways, showOnDemandShrink. | standard syntax: |
scrollbarOffset | Integer distance/offset passed to the native scrollbar; this handler does not apply screen scaling. Integer gap between the list content and scrollbar in native pixels. This setter does not apply screen scaling. | standard syntax: |
scrollbarRadius | Rounded scrollbar corners, optionally restricted to named edges. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
scrollbarScroll | Scrollbar movement granularity: byPage or byLine. Case-sensitive options: byPage, byLine. | standard syntax: |
scrollbarWidth | Scrollbar thickness, scaled horizontally. Integer design pixels, scaled horizontally with the screen. Use a non-negative value. | standard syntax: |
scrollText | Scrolling text configuration as comma-separated key=value pairs; direction, delays, repeat, stepSize and mode. Comma-separated key=value pairs. direction: left/right/top/bottom; stepDelay, startDelay, endDelay: milliseconds; stepSize: pixels; repeat: integer; mode: cached/bounce/bounceCached/roll. Omitted sub-options start at stepDelay=100, startDelay=0, endDelay=0, repeat=0, stepSize=2; omit mode for normal scrolling. | standard syntax: |
selection | Enable or disable drawing the list selection highlight. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
selectionPixmap | Image used for the list selection background. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
selectionZoom | Selection enlargement as an integer percentage increment[,mode]: 25 means 1.25 times the normal size. The increment is capped at 500; see parseZoom for the mode. Non-negative integer percentage increment[,mode]. 25 means 125% of normal size; capped at 500. Modes: zoomContent, moveContent, ignoreContent. | standard syntax: |
selectionZoomSize | Explicit enlarged selection width,height[,mode]. width,height[,mode]. Modes: zoomContent, moveContent, ignoreContent. Literal dimensions scale with the screen. | standard syntax: |
separatorLineColor | Colour of entry separators in supporting lists. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
separatorLineSize | Separator geometry: height, top,height or left,top,width,height; -1 has automatic/full-width meaning. height, top,height, or left,top,width,height. top=-1 centres the line; width=-1 uses the available width minus margins. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
spacingColor | Colour of spacing in a native widget that supports setSpacingColor. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
valueFont | Font for configuration values on supporting targets. Registered font face or alias, optionally followed by ;size. A numeric size is scaled vertically with the screen. Register the face before using it. | standard syntax: |
verticalAlignment | Text alignment inside the widget: top, center/middle or bottom. Case-sensitive options: top, center, middle, bottom. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
wrap | Text overflow mode: wrap, noWrap or ellipsis; current parser also accepts numeric strings. Case-sensitive options: ellipsis, noWrap, wrap. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (174)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvoid invalidate(const gRegion ®ion = gRegion::invalidRegion()) override— eListboxvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvoid setBackgroundColor(const gRGB &col) override— eListboxvoid clearBackgroundColor() override— eListboxvoid setBorderWidth(int width) override— eListboxvoid setBorderColor(const gRGB &col) override— eListboxvoid setWidgetBorderWidth(int width) override— eListboxvoid setWidgetBorderColor(const gRGB &col) override— eListboxvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvoid setPadding(const eRect &padding) override— eListboxeRect getPadding() override— eListboxvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setItemAlignment(int align)— eListboxvoid setScrollbarScroll(uint8_t scroll)— eListboxvoid setScrollbarMode(uint8_t mode)— eListboxvoid setWrapAround(bool state)— eListboxvoid setLockFirstRow(bool lock)— eListboxbool getLockFirstRow() const— eListboxvoid setOrientation(uint8_t orientation)— eListboxvoid setContent(iListboxContent *content)— eListboxvoid allowNativeKeys(bool allow)— eListboxvoid enableAutoNavigation(bool allow)— eListboxint getCurrentIndex() const— eListboxvoid moveSelection(int how)— eListboxvoid moveSelectionTo(int index)— eListboxvoid moveToEnd()— eListboxbool atBegin() const— eListboxbool atEnd() const— eListboxvoid goTop()— eListboxvoid goBottom()— eListboxvoid goLineUp()— eListboxvoid goLineDown()— eListboxvoid goPageUp()— eListboxvoid goPageDown()— eListboxvoid goLeft()— eListboxvoid goRight()— eListboxvoid goPageLeft()— eListboxvoid goPageRight()— eListboxvoid goFirst()— eListboxvoid goLast()— eListboxvoid setItemHeight(int h)— eListboxvoid setItemWidth(int w)— eListboxvoid setSelectionEnable(int en)— eListboxvoid setBackgroundColorSelected(const gRGB &col)— eListboxvoid setForegroundColor(const gRGB &col)— eListboxvoid setForegroundColorSelected(const gRGB &col)— eListboxvoid setBackgroundColorRows(const gRGB &col)— eListboxvoid setSpacingColor(const gRGB &col)— eListboxvoid clearSpacingColor()— eListboxvoid clearBackgroundColorSelected()— eListboxvoid clearForegroundColor()— eListboxvoid clearForegroundColorSelected()— eListboxvoid setBackgroundPixmap(ePtr<gPixmap> &pm)— eListboxvoid setSelectionPixmap(ePtr<gPixmap> &pm)— eListboxvoid setSelectionBorderHidden()— eListboxvoid setScrollbarForegroundPixmap(ePtr<gPixmap> &pm)— eListboxvoid setScrollbarBackgroundPixmap(ePtr<gPixmap> &pm)— eListboxvoid setScrollbarBorderWidth(int width)— eListboxvoid setScrollbarWidth(int size)— eListboxvoid setScrollbarHeight(int size)— eListboxvoid setScrollbarOffset(int size)— eListboxvoid setScrollbarLength(int size)— eListboxvoid setFont(gFont *font)— eListboxvoid setEntryFont(gFont *font)— eListboxvoid setValueFont(gFont *font)— eListboxvoid setHeaderFont(gFont *font)— eListboxvoid setFontScale(int scaleType, int size)— eListboxvoid setVAlign(int align)— eListboxvoid setHAlign(int align)— eListboxvoid setWrap(int wrap)— eListboxvoid setUseVTIWorkaround(void)— eListboxvoid setScrollbarBorderColor(const gRGB &col)— eListboxvoid setScrollbarForegroundColor(gRGB &col)— eListboxvoid setScrollbarBackgroundColor(gRGB &col)— eListboxvoid setScrollbarForegroundGradient(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eListboxvoid setScrollbarBackgroundGradient(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eListboxvoid setScrollbarRadius(int radius, uint8_t edges)— eListboxvoid setMaxRows(int rows)— eListboxvoid setMaxColumns(int columns)— eListboxvoid setItemSpacing(const ePoint &spacing, bool innerOnly = false)— eListboxvoid setItemCornerRadius(int radius, uint8_t edges)— eListboxvoid setItemCornerRadiusSelected(int radius, uint8_t edges)— eListboxvoid setItemCornerRadiusMarked(int radius, uint8_t edges)— eListboxvoid setItemCornerRadiusMarkedandSelected(int radius, uint8_t edges)— eListboxvoid setItemGradient(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eListboxvoid setItemGradientSelected(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eListboxvoid setItemGradientMarked(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eListboxvoid setItemGradientMarkedandSelected(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eListboxvoid setSelectionZoom(float zoom, int zoomContentMode = 0)— eListboxvoid setSelectionZoomSize(int width, int height, int zoomContentMode = 0)— eListboxvoid setSeparatorColor(const gRGB &col)— eListboxvoid setSeparatorSize(const eRect &size)— eListboxvoid setHeaderColor(const gRGB &col)— eListboxvoid setOverlay(ePtr<gPixmap> &pm)— eListboxvoid setPageSize(int size)— eListboxstatic void setDefaultScrollbarStyle(int width, int offset, int borderwidth, uint8_t scroll, uint8_t mode, bool enablewraparound)— eListboxstatic void setDefaultPadding(const eRect &padding)— eListboxstatic void setDefaultScrollbarRadius(int radius, uint8_t radiusEdges)— eListboxstatic void setDefaultItemRadius(int radius, uint8_t radiusEdges)— eListboxstatic void setDefaultItemRadiusSelected(int radius, uint8_t radiusEdges)— eListboxstatic void setDefaultItemRadiusMarked(int radius, uint8_t radiusEdges)— eListboxstatic void setDefaultItemRadiusMarkedAndSelected(int radius, uint8_t radiusEdges)— eListboxstatic void setDefaultHorizontalAlignment(int alignment)— eListboxstatic void setDefaultVerticalAlignment(int alignment)— eListboxvoid setTopIndex(int idx)— eListboxvoid setStartIndex(int index)— eListboxint getStartIndex() const— eListboxbool getWrapAround() const— eListboxuint8_t getScrollbarScroll() const— eListboxuint8_t getScrollbarMode() const— eListboxint getScrollbarWidth() const— eListboxint getScrollbarHeight() const— eListboxint getScrollbarOffset() const— eListboxint getScrollbarBorderWidth() const— eListboxint getItemAlignment() const— eListboxint getPageSize() const— eListboxint getItemHeight() const— eListboxint getItemWidth() const— eListboxuint8_t getOrientation() const— eListboxint getTopIndex() const— eListboxbool getSelectionEnable() const— eListboxgFont *getFont() const— eListboxgFont *getEntryFont() const— eListboxgFont *getValueFont() const— eListboxgFont *getHeaderFont() const— eListboxint getItemsPerPage() const— eListboxint getCurrentPage() const— eListboxint getPageCount() const— eListboxint getMaxItemTextWidth() const— eListboxvoid redrawItemByIndex(int index)— eListboxint getScrollbarListOffset() const— eListboxvoid setScrollText(int direction, long delay, long startDelay, long endDelay, int repeat, int stepSize, int mode)— eListbox#ifndef SWIG struct eListboxStyle *getLocalStyle(void)— eListboxvoid entryAdded(int index)— eListboxvoid entryRemoved(int index)— eListboxvoid entryChanged(int index)— eListboxvoid entryReset(bool cursorHome = true)— eListboxint getEntryTop() const— eListbox
ePixmap
Image widget: pixmap, scaling and alpha test/blending, plus base widget appearance. No font or text alignment attributes.
18 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (18)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
alphaTest | Pixmap transparency: off, on (alpha test), or blend (smooth alpha blending). Case-sensitive options: on, off, blend. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
pixmap | Resolved image path passed to LoadPixmap; PNG transparency is commonly used. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
scale | Pixmap scaling flags, for example none, scale, keepAspect or centerScaled. Not screen resolution scaling. Case-sensitive options: none, 0, scale, 1, keepAspect, leftTop, leftCenter, leftMiddle, leftBottom, centerTop, middleTop, centerScaled, middleScaled, centerBottom, middleBottom, rightTop, rightCenter, rightMiddle, rightBottom, moveLeftTop, moveLeftCenter, moveLeftMiddle, moveLeftBottom, moveCenterTop, moveMiddleTop, moveCenter, moveMiddle, moveCenterBottom, moveMiddleBottom, moveRightTop, moveRightCenter, moveRightMiddle, moveRightBottom, off, on, aspect, center, width, height, stretch, fill. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (58)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setPixmap(gPixmap* pixmap)— ePixmapvoid setPixmapFromFile(const char* filename, bool autoDetect = false)— ePixmapvoid setAlphatest(int alphatest)— ePixmapvoid setScale(int scale)— ePixmapvoid setPixmapScale(int flags)— ePixmapvoid setPixmapScaleFlags(int flags)— ePixmapvoid setAniPixmapFromFile(const char* filename, bool autostart = false)— ePixmapvoid startAnimation(bool once = false)— ePixmapvoid stopAnimation()— ePixmapeSize getPixmapSize() const— ePixmap
ePositionGauge
Playback position and seek/cut marker widget. pointer and seekPointer use filename:x,y syntax; the source/renderer supplies playback and cut-list values.
lib/gui/epositiongauge.h, line 13 ↗
18 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (18)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
foregroundColor | Text/foreground colour. A gradient value is supported only by the slider foreground path. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
pointer | Pointer image and anchor offset for supporting widgets; see the source setter for the colon-separated path/coordinate syntax. imageFilename:x,y. x,y is the pointer anchor offset; the target must support pointer index 0. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
seekPointer | Secondary seek pointer image and anchor offset, for widgets that support it. imageFilename:x,y. x,y is the pointer anchor offset; the target must support pointer index 1. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (57)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidget#ifndef SWIG protected: int event(int event, void *data=0, void *data2=0)— ePositionGaugevoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setLength(const pts_t &len)— ePositionGaugevoid setPosition(const pts_t &pos)— ePositionGaugevoid setInColor(const gRGB &color)— ePositionGaugevoid setPointer(int which, gPixmap *pixmap, const ePoint ¢er)— ePositionGaugevoid setInOutList(SWIG_PYOBJECT(ePyObject) list)— ePositionGaugevoid setForegroundColor(const gRGB &col)— ePositionGaugevoid setCutMark(const pts_t &where, int what)— ePositionGaugevoid enableSeekPointer(int enable)— ePositionGaugevoid setSeekPosition(const pts_t &pos)— ePositionGauge
eQRCode
QR-code widget. text supplies the encoded payload; errorCorrection, quietZone and colour/spacing options determine the generated symbol.
19 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (19)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
errorCorrection | QR code recovery level: low, medium, quartile or high. Case-sensitive options: low, medium, quartile, high. | standard syntax: |
foregroundColor | Text/foreground colour. A gradient value is supported only by the slider foreground path. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
quietZone | QR code quiet-zone size; does not add general-purpose label padding. Integer quiet-zone module count around a QR code. The parser uses 4 for an invalid integer; this is not ordinary pixel padding. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
text | Static text, translated before setText. Python or a renderer may replace it later. XML text string; escape & as & and < as <. Translated and set initially; renderer/Python updates can replace it. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (54)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvoid setBackgroundColor(const gRGB& color) override— eQRCodevirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setText(const std::string& text)— eQRCodestd::string getText() const— eQRCodevoid setErrorCorrection(int level)— eQRCodevoid setQuietZone(int modules)— eQRCodevoid setForegroundColor(const gRGB& color)— eQRCodebool isValid() const— eQRCode
eRectangle
Decorative rectangle. Uses the base widget background, gradient, corner and border attributes.
lib/gui/erectangle.h, line 6 ↗
15 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (15)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (48)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidget
eSlider
Progress or slider widget. Supports foreground/background images and gradients and the two-argument slider orientation parser. Several scrollbar names are compatibility mappings.
30 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (30)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
alphaTest | Pixmap transparency: off, on (alpha test), or blend (smooth alpha blending). Case-sensitive options: on, off, blend. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
backgroundPixmap | Background image for a native target implementing setBackgroundPixmap; not universal to all widgets. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
foregroundColor | Text/foreground colour. A gradient value is supported only by the slider foreground path. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
gradientMode | Slider gradient behaviour: legacy or explicit. Check the receiver version before using this newer option. legacy or explicit. Controls how a slider interprets its gradient; use only with a slider implementing setGradientMode. | standard syntax: |
orientation | Slider direction: orHorizontal/orLeftToRight, orRightToLeft, orVertical/orTopToBottom, orBottomToTop. Case-sensitive options: orHorizontal, orLeftToRight, orRightToLeft, orVertical, orTopToBottom, orBottomToTop. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
pixmap | Resolved image path passed to LoadPixmap; PNG transparency is commonly used. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
scale | Pixmap scaling flags, for example none, scale, keepAspect or centerScaled. Not screen resolution scaling. Case-sensitive options: none, 0, scale, 1, keepAspect, leftTop, leftCenter, leftMiddle, leftBottom, centerTop, middleTop, centerScaled, middleScaled, centerBottom, middleBottom, rightTop, rightCenter, rightMiddle, rightBottom, moveLeftTop, moveLeftCenter, moveLeftMiddle, moveLeftBottom, moveCenterTop, moveMiddleTop, moveCenter, moveMiddle, moveCenterBottom, moveMiddleBottom, moveRightTop, moveRightCenter, moveRightMiddle, moveRightBottom, off, on, aspect, center, width, height, stretch, fill. | standard syntax: |
scrollbarBackgroundColor | Solid colour behind the scrollbar handle. The implementation delegates to setBackgroundColor; this is a compatibility name for the slider background. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
scrollbarBackgroundGradient | Gradient behind the scrollbar handle on supporting targets. startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. | standard syntax: |
scrollbarBackgroundPixmap | Image behind the scrollbar handle. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
scrollbarBorderColor | Scrollbar border colour. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
scrollbarBorderWidth | Scrollbar border thickness, scaled horizontally. Integer design pixels, scaled horizontally with the screen. Use a non-negative value. | standard syntax: |
scrollbarForegroundColor | Scrollbar handle colour. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
scrollbarForegroundGradient | Scrollbar handle gradient. startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. | standard syntax: |
scrollbarForegroundPixmap | Scrollbar handle image. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (70)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvoid setBackgroundColor(const gRGB &color) override— eSlidervirtual void clearBackgroundColor()— eWidgetvoid setBorderWidth(int width) override— eSlidervoid setBorderColor(const gRGB &color) override— eSlidervoid setWidgetBorderWidth(int width) override— eSlidervoid setWidgetBorderColor(const gRGB &color) override— eSlidervirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eSlidervoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setValue(int val)— eSlidervoid setStartEnd(int start, int end, bool pixel = false)— eSlidervoid setRange(int min, int max)— eSlidervoid setOrientation(uint8_t orientation, uint8_t swapped = 0)— eSlidervoid setForegroundColor(const gRGB &color)— eSlidervoid setPixmap(gPixmap *pixmap)— eSlidervoid setBackgroundPixmap(gPixmap *pixmap)— eSlidervoid setPixmapScale(int flags)— eSlidervoid setAlphatest(int alphatest)— eSlidervoid setIsScrollbar()— eSlidervoid setGradientMode(bool explicitMode)— eSliderstatic void setDefaultBorderWidth(int borderwidth)— eSliderint getBorderWidth()— eSlidervoid setScrollbarBorderWidth(int width)— eSlidervoid setScrollbarBorderColor(const gRGB &color)— eSlidervoid setScrollbarForegroundPixmap(gPixmap *pixmap)— eSlidervoid setScrollbarBackgroundPixmap(gPixmap *pixmap)— eSlidervoid setScrollbarForegroundColor(const gRGB &color)— eSlidervoid setScrollbarBackgroundColor(const gRGB &color)— eSlidervoid setForegroundGradient(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend, bool fullColor = false)— eSlidervoid setScrollbarForegroundGradient(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend, bool fullColor = false)— eSlidervoid setScrollbarBackgroundGradient(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eSlider
eStack
Layout container whose children use align. Geometry and appearance are inherited from eWidget; it is not a text label or listbox.
16 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (16)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
spacing | Spacing setter for supporting native widgets; a panel also consumes spacing for its layout context. Integer spacing used by the native stack/layout; panel spacing is handled by the structural parser. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (54)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvoid show() override— eStackvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetstd::string dumpObject() const override— eStackvoid setLayoutDirection(LayoutDirection dir)— eStackLayoutDirection layoutDirection() const— eStackvoid addChild(eWidget* child)— eStackvoid removeChild(eWidget* child)— eStackint getSpacing() const— eStackvoid setSpacing(int spacing)— eStack
eSubtitleWidget
Native subtitle display surface. DVB/teletext subtitle styles are configured by the subtitle skin resources; they are not arbitrary label attributes on this widget.
lib/gui/esubtitle.h, line 43 ↗
16 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (16)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
pixmap | Resolved image path passed to LoadPixmap; PNG transparency is commonly used. Image filename, resolved in the skin context before loading. Supply an existing PNG/SVG or another supported image; the sample path must be replaced with your asset. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (53)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setPage(const eDVBTeletextSubtitlePage &p)— eSubtitleWidgetvoid clearPage()— eSubtitleWidgetvoid setPixmap(ePtr<gPixmap> &pixmap, gRegion changed, eRect dest = eRect(0, 0, 720, 576))— eSubtitleWidgetvoid destroy()— eSubtitleWidget#endif static void setFontStyle(subfont_t face, gFont *font, int autoColor, const gRGB &col, const gRGB &borderCol, int borderWidth)— eSubtitleWidget
eVideoWidget
Native video plane wrapper derived from eLabel. Inherited label methods exist, but video placement/decoder behaviour is controlled by Pig or VideoWindow and the receiver driver.
31 current central XML attribute names. Inherits eLabel. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (31)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
alphaTest | Pixmap transparency: off, on (alpha test), or blend (smooth alpha blending). For eLabel and its subclasses, both on and blend enable text blending: setAlphatest maps any positive mode to the same boolean. The three-way pixmap distinction does not apply here. Case-sensitive options: on, off, blend. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. Inherited eLabel override: text outline, not the video-plane border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Inherited eLabel override: text outline, not the video-plane border. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
font | Registered font face or alias and size, for example Regular;28. It is not a font file path. Registered font face or alias, optionally followed by ;size. A numeric size is scaled vertically with the screen. Register the face before using it. | standard syntax: |
fontScale | Automatic label font adjustment: size;offset or width;offset (default offset -4). size;offset or width;offset. Offset is an integer; omitted offset is -4. An offset of 0 does not call the setter. | standard syntax: |
foregroundColor | Text/foreground colour. A gradient value is supported only by the slider foreground path. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: |
horizontalAlignment | Text alignment inside its rectangle: left, center, right or block. Case-sensitive options: left, center, right, block. | standard syntax: |
overScan | Pass the overscan value to a native target implementing setOverscan; this is not global TV calibration. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
scrollText | Scrolling text configuration as comma-separated key=value pairs; direction, delays, repeat, stepSize and mode. Comma-separated key=value pairs. direction: left/right/top/bottom; stepDelay, startDelay, endDelay: milliseconds; stepSize: pixels; repeat: integer; mode: cached/bounce/bounceCached/roll. Omitted sub-options start at stepDelay=100, startDelay=0, endDelay=0, repeat=0, stepSize=2; omit mode for normal scrolling. | standard syntax: |
shadowColor | Colour of the label text shadow. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
shadowOffset | x,y offset of the text shadow; scaled with the screen. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | standard syntax: |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tabWidth | Tab-stop width for supporting text widgets; auto uses the automatic width. Non-negative integer tab-stop width, or auto for automatic sizing. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
text | Static text, translated before setText. Python or a renderer may replace it later. XML text string; escape & as & and < as <. Translated and set initially; renderer/Python updates can replace it. | standard syntax: |
textBorderColor | Explicit colour of the outline around glyphs; different from a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
textBorderWidth | Explicit glyph-outline thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
underline | Enable or disable underlined label text. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
verticalAlignment | Text alignment inside the widget: top, center/middle or bottom. Case-sensitive options: top, center, middle, bottom. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
wrap | Text overflow mode: wrap, noWrap or ellipsis; current parser also accepts numeric strings. Case-sensitive options: ellipsis, noWrap, wrap. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (78)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvoid setBorderWidth(int width) override— eLabelvoid setBorderColor(const gRGB& col) override— eLabelvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setText(const std::string& string)— eLabelvoid setMarkedPos(int markedPos)— eLabelvoid setFont(gFont* font)— eLabelgFont* getFont()— eLabelvoid setVAlign(int align)— eLabelvoid setHAlign(int align)— eLabelvoid setForegroundColor(const gRGB& col)— eLabelvoid setShadowColor(const gRGB& col)— eLabelvoid setShadowOffset(const ePoint& offset)— eLabelvoid setTextBorderColor(const gRGB& col)— eLabelvoid setTextBorderWidth(int width)— eLabelvoid setWrap(int wrap)— eLabelvoid setNoWrap(int nowrap)— eLabelvoid setUnderline(bool underline)— eLabelvoid setScrollText(int direction, long delay, long startDelay, long endDelay, int repeat, int stepSize, int mode)— eLabelvoid clearForegroundColor()— eLabelint getWrap() const— eLabelint getNoWrap() const— eLabelvoid setAlphatest(int alphatest)— eLabelvoid setTabWidth(int width)— eLabelgRGB getForegroundColor(int styleID = 0)— eLabeleSize calculateSize()— eLabelstatic eSize calculateTextSize(gFont* font, const std::string& string, eSize targetSize, bool nowrap = false)— eLabelvoid setFontScale(int scaleType, int size)— eLabelvoid setDecoder(int target)— eVideoWidgetvoid setOverscan(bool overscan)— eVideoWidgetvoid setFBSize(eSize size)— eVideoWidgetvoid setFullScreenPosition(eRect pos)— eVideoWidgetvoid restoreFullsize()— eVideoWidgetstatic void setFullsize(bool force = false, bool mainOnly = false)— eVideoWidget
eWidget
Base widget: geometry, background, borders, transparency and stacking. It does not implement text, pixmap or list content.
15 current central XML attribute names. Inherits no other widget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (15)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (48)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgetvirtual eWidget* child()— eWidgeteWidget* getParent()— eWidgetvirtual void show()— eWidgetvoid hide()— eWidgetvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvirtual void setBackgroundColor(const gRGB& col)— eWidgetvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB& startcolor, const gRGB& midcolor, const gRGB& endcolor, uint8_t direction, bool alphablend)— eWidgetvoid setCornerRadius(int radius, uint8_t edges)— eWidgetuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidget
eWindow
Screen window. Adds title, window flags and animation mode to the base widget. Use these on the screen rather than on a Label renderer.
18 current central XML attribute names. Inherits eWidget. Appearance also depends on the Python component and content.
Attributes, meaning and supported value variants (18)
| XML attribute | Meaning / syntax | Native dispatch |
|---|---|---|
align | Stack alignment passed to setAlign; this is an engine-facing value, not text alignment. The handler forwards the XML string unchanged to a native numeric/Boolean setter. No reliable general XML authoring syntax is established by this handler. | standard syntax: |
alphaBlend | Enable native widget background/border alpha blending where supported; useful for overlaying translucent rectangles. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
animationMode | Control window show/hide animation; off disables both directions. Case-sensitive options: disable, off, offshow, offhide, onshow, onhide, disable_onshow, disable_onhide. | standard syntax: |
backgroundColor | Solid #AARRGGBB/named colour, or gradient specification start[,middle],end,direction[,alphaBlend]. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. A gradient can also use startColour[,middleColour],endColour,horizontal|vertical[,alphaBlend]. Use named colours or #AARRGGBB; the optional alphaBlend is Boolean. Only widgets with the gradient variant listed below accept it. | solid colour: gradient: |
backgroundColorOdd | Solid base/odd-row list background; gradients are not accepted here. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderColor | Generic border setter. On eLabel this currently changes the text outline; use widgetBorderColor for a rectangle border. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
borderWidth | Generic border width. On eLabel this currently changes glyph outlines; use widgetBorderWidth for the widget frame. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
cornerRadius | Corner radius, optionally followed by a semicolon and edge names, e.g. 24;topLeft,topRight. Integer radius, optionally ; followed by comma-separated edges: topLeft, topRight, top, bottomLeft, bottomRight, bottom, left, right. Omit edges for all corners. | standard syntax: |
flags | Comma-separated eWindow flags, for example wfNoBorder; belongs on a screen/window. Comma-separated eWindow flag names, such as wfNoBorder. On template text, flags has a different meaning; see the underline recipe. | standard syntax: |
padding | One, two or four comma-separated inset values: left,top,right,bottom. Two values repeat as x,y,x,y. One integer for all sides; x,y repeats x,y,x,y; four integers are left,top,right,bottom. These values are passed through without screen scaling. | standard syntax: |
position | x,y relative to the current layout context; centre and arithmetic coordinates are supported. x,y coordinates in the design coordinate system. Literal numbers are scaled; parent-relative expressions such as center and percentages are context dependent. | |
size | width,height of the widget; does not set its text alignment or font size. width,height in the design coordinate system. Literal values are scaled with the screen. | standard syntax: |
tag | Integer widget identifier used by native stack/layout machinery. Integer native widget tag. This does not bind a Python component; use name for that. | standard syntax: |
title | Window title; translated with the current interface locale before being applied. XML text string used as the screen title; translated before application. | standard syntax: |
transparent | Boolean: suppress the widget background. This is distinct from the transparency byte in a painted colour. Boolean: 1 / yes / true / on / enabled enables it; 0 / no / false / off disables it. Case-insensitive. Other unrecognised strings also evaluate false. | standard syntax: |
widgetBorderColor | Explicit rectangular widget-frame colour, including on eLabel. A registered colour name or #AARRGGBB. AA is transparency: 00 opaque, FF transparent. Example: #00FFFFFF is opaque white. | standard syntax: |
widgetBorderWidth | Explicit rectangular widget-frame thickness, scaled vertically. Integer design pixels, scaled vertically with the screen. Use a non-negative value. | standard syntax: |
zPosition | Integer painting layer among overlapping widgets; larger values are in front. Integer stacking order; higher values paint in front of lower values in the same parent. | standard syntax: |
Public native methods, including inherited declarations (53)
void move(ePoint pos)— eWidgetvoid resize(eSize size)— eWidgetePoint position() const— eWidgeteSize size() const— eWidgeteSize csize() const— eWidgetvirtual void invalidate(const gRegion& region = gRegion::invalidRegion())— eWidgeteWidget *child()— eWindoweWidget* getParent()— eWidgetvoid show()— eWindowvoid hide()— eWindowvoid raise()— eWidgetvoid lower()— eWidgetvoid destruct()— eWidgetSWIG_VOID(int) getStyle(ePtr<eWindowStyle>& SWIG_NAMED_OUTPUT(style))— eWidgetvoid setStyle(eWindowStyle* style)— eWidgetvoid setBackgroundColor(const gRGB &col) override— eWindowvirtual void clearBackgroundColor()— eWidgetvirtual void setBorderWidth(int width)— eWidgetvirtual void setBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetBorderWidth(int width)— eWidgetvirtual void setWidgetBorderColor(const gRGB& color)— eWidgetvirtual void setWidgetAlphaBlend(bool blend)— eWidgetvirtual void setPadding(const eRect& padding)— eWidgetvirtual eRect getPadding()— eWidgetvoid setZPosition(int z)— eWidgetvoid setTransparent(int transp)— eWidgetint isVisible()— eWidgetint isLowered()— eWidgetint isTransparent()— eWidgetvoid setModal(int m)— eWidgetint isModal() const— eWidgetePoint getAbsolutePosition()— eWidgetint getTag() const— eWidgetvoid setTag(int tag)— eWidgetvirtual int event(int event, void* data = 0, void* data2 = 0)— eWidgetvoid setFocus(eWidget* focus)— eWidgetvoid setPositionNotifyChild(int n)— eWidgetvoid notifyShowHide()— eWidgetvoid setBackgroundGradient(const gRGB &startcolor, const gRGB &midcolor, const gRGB &endcolor, uint8_t direction, bool alphablend)— eWindowvoid setCornerRadius(int radius, uint8_t edges)— eWindowuint8_t getCornerRadiusEdges()— eWidgetint getCornerRadius()— eWidgetbool isGradientSet()— eWidgetvoid setAlign(uint8_t a)— eWidgetuint8_t align() const— eWidgetvoid setStack(eWidget* stack)— eWidgetvirtual std::string getClassName() const— eWidgetvirtual std::string dumpObject() const— eWidgetvoid setTitle(const std::string &string)— eWindowstd::string getTitle() const— eWindowvoid setFlag(int flags)— eWindowvoid clearFlag(int flags)— eWindowvoid setAnimationMode(int mode)— eWindow
No matching class. Clear the filter or use the handbook search.
Attributes that look similar but behave differently
Abschnitt betitelt „Attributes that look similar but behave differently“| Attribute | Distinction |
|---|---|
borderColor, borderWidth |
On eLabel and its subclasses these address the text outline. On other classes they use that class’s border implementation. |
widgetBorderColor, widgetBorderWidth |
Explicit widget border, including on a label. |
alphaTest |
Pixmap/text raster handling where supported; not the same as widget alphaBlend. |
transparent |
Controls widget background behaviour. It does not turn an opaque image file into an image with alpha. |
text |
Sets initial label content; a renderer can replace it from source.text. |
font |
Label or supported list font. A Canvas drawing command supplies its own font rather than using a native font XML attribute. |
position, size |
Geometry of this widget, not the row indexes or geometry inside a MultiContent template. |
For visual comparisons, use the captured text examples, colour/layer examples, image examples and InfoBar progress examples. The tables describe API support; the examples show how selected values actually render.
