Webapp

Button

Clickable button widget.

40 config keys · 33 public methods

Import

from Xenonix.Webapp import Button

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

Config key	Default	Common values	What it controls
`Name`	`False`	Any valid value	Object name used for lookup, labels, or public access.
`Background`	`False`	Any valid value	Background color.
`Foreground`	`'#000000'`	Any valid value	Text/foreground color.
`Border_Color`	`'transparent'`	Any valid value	Border color.
`Border_Size`	`0`	Any valid value	Border thickness.
`Border_Radius`	`0`	Any valid value	Corner radius.
`Shadow_X`	`0`	Any valid value	Horizontal shadow offset.
`Shadow_Y`	`0`	Any valid value	Vertical shadow offset.
`Shadow_Blur`	`0`	Any valid value	Shadow blur amount.
`Shadow_Spread`	`0`	Any valid value	Shadow spread amount.
`Shadow_Color`	`'transparent'`	Any valid value	Shadow color.
`Display`	`True`	`True`, `False`	Initial visible/hidden state.
`Left`	`None`	Any valid value	Left position when placed absolutely.
`Top`	`None`	Any valid value	Top position when placed absolutely.
`Right`	`None`	Any valid value	Right position when placed absolutely.
`Bottom`	`None`	Any valid value	Bottom position when placed absolutely.
`Width`	`None`	Any valid value	Widget or image width.
`Height`	`None`	Any valid value	Widget or image height.
`Animate_Left`	`0`	Any valid value	Animate Left setting for Button.
`Animate_Top`	`0`	Any valid value	Animate Top setting for Button.
`Animate_Width`	`0`	Any valid value	Animate Width setting for Button.
`Animate_Height`	`0`	Any valid value	Animate Height setting for Button.
`Animate_Time`	`1.0`	Any valid value	Animate Time setting for Button.
`Animate_Ease`	`'cubic-bezier(0.22, 1, 0.36, 1)'`	Any valid value	Animate Ease setting for Button.
`Font_Size`	`12`	Any valid value	Font Size setting for Button.
`Font_Weight`	`'normal'`	Any valid value	Font Weight setting for Button.
`Font_Family`	`'Helvetica'`	Any valid value	Font Family setting for Button.
`Align`	`'center'`	Any valid value	Align setting for Button.
`Value`	`''`	Any valid value	Value setting for Button.
`Icon`	`''`	Any valid value	Icon setting for Button.
`Hover_Background`	`False`	Any valid value	Hover Background setting for Button.
`Hover_Foreground`	`False`	Any valid value	Hover Foreground setting for Button.
`Hover_Border_Color`	`False`	Any valid value	Hover Border Color setting for Button.
`Padding`	`0`	Any valid value	Inner spacing.
`Margin`	`0`	Any valid value	Extra region margin.
`Mode`	`'Flow'`	`Flow`, `Place`, `Auto`, `Manual`	Layout or algorithm mode.
`Classes`	`''`	Any valid value	Extra CSS classes.
`Style`	`''`	Any valid value	Extra CSS style.
`Z_Index`	`None`	Any valid value	CSS stacking order.
`Disable`	`False`	Any valid value	Disable setting for Button.

Public methods

Create

Creates a new Button instance.

Create(Main, *Args, **Kwargs)

Arguments

Argument	Default	Accepted values	What it does
`Main`	Required	Any valid value	Main value used by the operation.
`Args`	`*args`	Any valid value	Args value used by the operation.
`Kwargs`	`**kwargs`	Any valid value	Kwargs value used by the operation.

Output

Creates a new Button object.

Create

Runs the Create operation for Button.

Create()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy(Name=False, Main=False)

Arguments

Argument	Default	Accepted values	What it does
`Name`	`False`	Any valid value	Display/name identifier.
`Main`	`False`	Any valid value	Turns main on or off.

Output

Returns a copy of the object.

Delete

Removes the requested item.

Delete()

Arguments

No arguments.

Output

Runs the operation. Some methods update the object in place.

Show

Displays the object/result.

Show()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Hide

Hides the object/result.

Hide()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Animate

Runs the Animate operation for Button.

Animate(Widget=None, Hide=False, Thread=True)

Arguments

Argument	Default	Accepted values	What it does
`Widget`	`None`	Any valid value	Widget value used by the operation.
`Hide`	`False`	Any valid value	Turns hide on or off.
`Thread`	`True`	Any valid value	Turns thread on or off.

Output

Returns True/False to indicate success.

Animate_Cancel

Runs the Animate_Cancel operation for Button.

Animate_Cancel()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Focus

Moves focus to this widget/object where supported.

Focus()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Get

Runs the Get operation for Button.

Get()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Icon

Runs the Icon operation for Button.

Icon(Icon=None)

Arguments

Argument	Default	Accepted values	What it does
`Icon`	`None`	Any valid value	Icon value used by the operation.

Output

Returns the calculated result.

Set

Runs the Set operation for Button.

Set(Value=None, Icon=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.
`Icon`	`None`	Any valid value	Icon value used by the operation.

Output

Returns the calculated result.

Value

Runs the Value operation for Button.

Value(Value=None, Icon=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.
`Icon`	`None`	Any valid value	Icon value used by the operation.

Output

Returns the calculated result.

Bind

Runs the Bind operation for Button.

Bind(**Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Runs the operation. Some methods update the object in place.

Config_Get

Reads one or more configuration values by name.

Config_Get(*Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`*args`	Any valid value	Input value used by the operation.

Output

Returns selected configuration values.

Config

Changes one or more supported settings. Pass only the configuration keys you want to update.

Config(**Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Updates configuration values on the object.

Move

Moves the object/data by the requested amount.

Move(Left=None, Top=None)

Arguments

Argument	Default	Accepted values	What it does
`Left`	`None`	Any valid value	Left value used by the operation.
`Top`	`None`	Any valid value	Top value used by the operation.

Output

Returns True/False to indicate success.

Center

Runs the Center operation for Button.

Center(Left=None, Top=None)

Arguments

Argument	Default	Accepted values	What it does
`Left`	`None`	Any valid value	Left value used by the operation.
`Top`	`None`	Any valid value	Top value used by the operation.

Output

Returns structured data such as a list or dictionary.

Position

Runs the Position operation for Button.

Position(Left=None, Top=None, Right=None, Bottom=None)

Arguments

Argument	Default	Accepted values	What it does
`Left`	`None`	Any valid value	Left value used by the operation.
`Top`	`None`	Any valid value	Top value used by the operation.
`Right`	`None`	Any valid value	Right value used by the operation.
`Bottom`	`None`	Any valid value	Bottom value used by the operation.

Output

Returns structured data such as a list or dictionary.

Size

Runs the Size operation for Button.

Size(Width=False, Height=False)

Arguments

Argument	Default	Accepted values	What it does
`Width`	`False`	Any valid value	Width in pixels, world units, or widget units depending on the class.
`Height`	`False`	Any valid value	Height in pixels, world units, or widget units depending on the class.

Output

Returns structured data such as a list or dictionary.

Enlarge

Runs the Enlarge operation for Button.

Enlarge(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns True/False to indicate success.

Shrink

Runs the Shrink operation for Button.

Shrink(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns True/False to indicate success.

Box

Runs the Box operation for Button.

Box()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Ratio

Runs the Ratio operation for Button.

Ratio()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Colors

Runs the Colors operation for Button.

Colors(Background=None, Foreground=None, Border_Color=None)

Arguments

Argument	Default	Accepted values	What it does
`Background`	`None`	Any valid value	Background value used by the operation.
`Foreground`	`None`	Any valid value	Foreground value used by the operation.
`Border_Color`	`None`	Any valid value	Border Color value used by the operation.

Output

Returns structured data such as a list or dictionary.

Font

Runs the Font operation for Button.

Font(Size=None, Weight=None, Family=None, Align=None)

Arguments

Argument	Default	Accepted values	What it does
`Size`	`None`	Any valid value	Size value used by the operation or widget.
`Weight`	`None`	Any valid value	Weight value used by the operation.
`Family`	`None`	Any valid value	Family value used by the operation.
`Align`	`None`	Any valid value	Align value used by the operation.

Output

Returns structured data such as a list or dictionary.

Radius

Runs the Radius operation for Button.

Radius(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Shadow

Runs the Shadow operation for Button.

Shadow(X=None, Y=None, Blur=None, Spread=None, Color=None)

Arguments

Argument	Default	Accepted values	What it does
`X`	`None`	Any valid value	X coordinate or horizontal value.
`Y`	`None`	Any valid value	Y coordinate or vertical value.
`Blur`	`None`	Any valid value	Blur value used by the operation.
`Spread`	`None`	Any valid value	Spread value used by the operation.
`Color`	`None`	Any valid value	Color used for drawing or display.

Output

Returns structured data such as a list or dictionary.

Disable

Runs the Disable operation for Button.

Disable(Value=True)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`True`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Enable

Runs the Enable operation for Button.

Enable()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Place

Runs the Place operation for Button.

Place(Left=None, Top=None, Right=None, Bottom=None, Width=None, Height=None)

Arguments

Argument	Default	Accepted values	What it does
`Left`	`None`	Any valid value	Left value used by the operation.
`Top`	`None`	Any valid value	Top value used by the operation.
`Right`	`None`	Any valid value	Right value used by the operation.
`Bottom`	`None`	Any valid value	Bottom value used by the operation.
`Width`	`None`	Any valid value	Width in pixels, world units, or widget units depending on the class.
`Height`	`None`	Any valid value	Height in pixels, world units, or widget units depending on the class.

Output

Returns the object, so the call can be chained.

Pack

Runs the Pack operation for Button.

Pack(Classes=None, Style=None, Margin=None, Padding=None)

Arguments

Argument	Default	Accepted values	What it does
`Classes`	`None`	Any valid value	Classes value used by the operation.
`Style`	`None`	Any valid value	Style value used by the operation.
`Margin`	`None`	Any valid value	Margin value used by the operation.
`Padding`	`None`	Any valid value	Padding value used by the operation.

Output

Returns the object, so the call can be chained.