Element Styles¶

Overview¶

`ButtonStyle`([proto])	The appearance of a `button()` for a given state.
`ButtonStyleSheet`(active[, hovered, pressed, ...])	The appearance of a `button()`.
`CheckboxStyle`([proto])	The appearance of a `checkbox()` for some state.
`CheckboxStyleSheet`(active[, hoverered, ...])	The appearance of a `checkbox()`.
`ContainerStyle`	alias of `pyiced.ContainerStyleSheet`
`ContainerStyleSheet`([proto])	The appearance of a `container()`.
`PaneGridStyle`	alias of `pyiced.PaneGridStyleSheet`
`PaneGridStyleSheet`([proto])	The appearance of a `pane_grid()`.
`PickListMenu`([proto])	The appearance of a pick list menu.
`PickListStyle`([proto])	The appearance of a `pick_list()` for some state.
`PickListStyleSheet`(menu, active[, hovered])	The appearance of a `pick_list()`.
`ProgressBarStyle`	alias of `pyiced.ProgressBarStyleSheet`
`ProgressBarStyleSheet`([proto])	The appearance of a `progress_bar()`.
`RadioStyle`([proto])	The appearance of a `radio()` for some state.
`RadioStyleSheet`(active[, hovered])	The appearance of a `radio()`.
`RuleStyle`	alias of `pyiced.RuleStyleSheet`
`RuleStyleSheet`([proto])	The appearance of a `rule()`.
`ScrollableStyleSheet`(active[, hovered, dragging])	The appearance of a `scrollable()`.
`ScrollbarStyle`([proto])	The appearance a specific state of a `scrollable()`.
`ScrollerStyle`([proto])	The appearance of the scroller of a `scrollable()`.
`SliderStyle`([proto])	The appearance of a `slider()` for some state.
`SliderStyleSheet`(active[, hovered, dragging])	The appearance of a `slider()`.
`TextInputStyle`([proto])	The appearance of a `text_input()` for some state.
`TextInputStyleSheet`(active[, focused, ...])	The appearance of a `text_input()`.
`TooltipStyle`	alias of `pyiced.ContainerStyleSheet`
`TooltipStyleSheet`	alias of `pyiced.ContainerStyleSheet`

Quick Example¶

from pyiced import (
    Align, button, ButtonState, ButtonStyle, ButtonStyleSheet, Color,
    container, ContainerStyle, IcedApp, Length, Settings, text,
    WindowSettings,
)


class ButtonExample(IcedApp):
    class settings(Settings):
        class window(WindowSettings):
            size = (640, 320)

    def __init__(self):
        self.__button_state = ButtonState()

    def title(self):
        return 'A Button'

    def view(self):
        styled_button = button(
            self.__button_state,
            text('Hello, world!', size=40),
            '',
            style=ButtonStyleSheet(ButtonStyle(
                shadow_offset=(8, 8), border_radius=40, border_width=6,
                background=Color(0.17, 0.17, 0.17),
                border_color=Color(0.95, 0.87, 0.22),
                text_color=Color(1.00, 0.18, 0.13)
            )),
            padding=40,
        )
        return container(
            styled_button,
            style=ContainerStyle(background=Color(0.38, 0.60, 0.23)),
            padding=20, align_x=Align.CENTER, align_y=Align.CENTER,
            width=Length.FILL, height=Length.FILL,
        )


if __name__ == '__main__':
    ButtonExample().run()

Details¶

class pyiced.ButtonStyle(proto=None, **kwargs)¶

The appearance of a button() for a given state.

Parameters

proto (Optional[ButtonStyleSheet]) – Source style sheet to clone and modify. Defaults to iced_style’s default style.
shadow_offset (Tuple[float, float]) – The button’s shadow offset.
background (Optional[Color]) – The button’s background color.
border_radius (float) – The button’s border radius.
border_width (float) – The button’s border width.
border_color (Color) – The button’s border color.
text_color (Color) – The button’s text color.

See also

iced::widget::button::Style

class pyiced.ButtonStyleSheet(active, hovered=None, pressed=None, disabled=None)¶

The appearance of a button().

Parameters

active (ButtonStyle) – Normal style of the button.
hovered (Optional[ButtonStyle]) – Style of the button when the cursor is hovering over it. Defaults to a style derived from “active”.
pressed (Optional[ButtonStyle]) – Style of the button while it’s pressed down. Defaults to a style derived from “active”.
disabled (Optional[ButtonStyle]) – Style of the button when no “on_press” argument was given. Defaults to a style derived from “active”.

See also

iced::widget::button::StyleSheet

active¶

The “active” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: ButtonStyle

disabled¶

The “disabled” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: ButtonStyle

hovered¶

The “hovered” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: ButtonStyle

pressed¶

The “pressed” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: ButtonStyle

class pyiced.CheckboxStyle(proto=None, **kwargs)¶

The appearance of a checkbox() for some state.

Parameters

proto (Optional[Union[CheckboxStyle, str]]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.

The valid string values are “active”, “hovered”, “active_checked” and “hovered_checked”, same as the argument for pyiced.~CheckboxStyleSheet.

None is the same as “active”.
background (Color) – The checkbox’ background color.
checkmark_color (Color) – The color of the checkbox.
border_radius (float) – The checkbox’ border radius.
border_width (float) – The checkbox’ border width.
border_color (Color) – The checkbox’ border color.

See also

iced::widget::checkbox::Style

background¶

The “background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_color¶

The “border_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_radius¶

The “border_radius” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

border_width¶

The “border_width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

checkmark_color¶

The “checkmark_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

class pyiced.CheckboxStyleSheet(active, hoverered=None, active_checked=None, hovered_checked=None)¶

The appearance of a checkbox().

Parameters

active (CheckboxStyle) – Normal style of this checkbox.
hovered (Optional[CheckboxStyle]) – Style when hovering over the checkbox. Defaults to the same style as “active”.
active_checked (Optional[CheckboxStyle]) – Style of this checkbox when the checkbox is checked. Defaults to the same style as “active”.
hovered_checked (Optional[CheckboxStyle]) – Style when hovering over the checked checkbox. If None or absent, it defaults to the first argument with an explicit value in “hovered”, “active_checked” or “active”.

See also

iced::widget::checkbox::StyleSheet

active¶

The “active” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: CheckboxStyle

active_checked¶

The “active_checked” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: CheckboxStyle

hovered¶

The “hovered” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: CheckboxStyle

hovered_checked¶

The “hovered_checked” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: CheckboxStyle

pyiced.ContainerStyle¶: alias of pyiced.ContainerStyleSheet

class pyiced.ContainerStyleSheet(proto=None, **kwargs)¶

The appearance of a container().

Parameters

proto (Optional[ContainerStyleSheet]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.
text_color (Optional[Color]) – The container’s text color.
background (Optional[Color]) – The container’s background color.
border_radius (float) – The container’s border radius.
border_width (float) – The container’s border width.
border_color (Color) – The container’s border color.

See also

background¶

The “background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Optional[Color]

border_color¶

The “border_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_radius¶

The “border_radius” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

border_width¶

The “border_width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

text_color¶

The “text_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Optional[Color]

pyiced.PaneGridStyle¶: alias of pyiced.PaneGridStyleSheet

class pyiced.PaneGridStyleSheet(proto=None, **kwargs)¶

The appearance of a pane_grid().

Parameters

proto (Optional[PaneGridStyleSheet]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.
picked_split (Optional[Line]) – The line to draw when a split is picked.
hovered_split (Optional[Line]) – The line to draw when a split is hovered.

See also

hovered_split¶

The “hovered_split” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Optional[Line]

picked_split¶

The “picked_split” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Optional[Line]

class pyiced.PickListMenu(proto=None, **kwargs)¶

The appearance of a pick list menu.

Parameters

proto (Optional[PickListMenu]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.
text_color (Color) – The text color of the menu.
background (Color) – The background color of the menu.
border_width (float) – The border width of the menu.
border_color (Color) – The border color of the menu.
selected_text_color (Color) – The text color of the selected element.
selected_background (Color) – Text background color of the selected element.

See also

iced::widget::pick_list::Menu

background¶

The “background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_color¶

The “border_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_width¶

The “border_width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

selected_background¶

The “selected_background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

selected_text_color¶

The “selected_text_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

text_color¶

The “text_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

class pyiced.PickListStyle(proto=None, **kwargs)¶

The appearance of a pick_list() for some state.

Parameters

proto (Optional[Union[PickListStyle, str]]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.

The valid string values are “active” and “hovered”, same as the argument for PickListStyleSheet.

None is the same as “active”.
text_color (Color) – The pick list’s foreground color.
background (Color) – The pick list’s background color.
border_radius (float) – The pick list’s border radius.
border_width (float) – The pick list’s border width.
border_color (Color) – The pick list’s border color.
icon_size (float) – The pick list’s arrow down icon size.

See also

iced::widget::pick_list::Style

background¶

The “background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_color¶

The “border_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_radius¶

The “border_radius” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

border_width¶

The “border_width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

icon_size¶

The “icon_size” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

text_color¶

The “text_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

class pyiced.PickListStyleSheet(menu, active, hovered=None)¶

The appearance of a pick_list().

Parameters

menu (PickListMenu) – Style of the drop down menu.
active (PickListStyle) – Normal style of the pick list.
hovered (Optional[PickListStyle]) – Style of the pick list when the cursor is hovering over it. Defaults to “active”.

See also

iced::widget::pick_list::StyleSheet

active¶

The “active” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: PickListStyle

hovered¶

The “hovered” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: PickListStyle

menu¶

The “menu” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: PickListMenu

pyiced.ProgressBarStyle¶: alias of pyiced.ProgressBarStyleSheet

class pyiced.ProgressBarStyleSheet(proto=None, **kwargs)¶

The appearance of a progress_bar().

Parameters

background (Color) – The progress bar’s background color.
bar (Color) – The progress bar’s foreground color.
border_radius (float) – The progress bar’s border radius.

See also

background¶

The “background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

bar¶

The “bar” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_radius¶

The “border_radius” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

class pyiced.RadioStyle(proto=None, **kwargs)¶

The appearance of a radio() for some state.

Parameters

proto (Optional[Union[RadioStyle, str]]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.

The valid string values are “active” and “hovered”, same as the argument for RadioStyleSheet.

None is the same as “active”.
background (Color) – The radio’s background color.
dot_color (Color) – The color of the dot.
border_width (float) – The radio’s border width.
border_color (Color) – The radio’s border color.

See also

iced::widget::radio::Style

background¶

The “background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_color¶

The “border_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_width¶

The “border_width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

dot_color¶

The “dot_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

class pyiced.RadioStyleSheet(active, hovered=None)¶

The appearance of a radio().

Parameters

active (RadioStyle) – Normal style of the radio.
hovered (Optional[RadioStyle]) – Style of the radio when the cursor is hovering over it. Defaults to “active”.

See also

iced::widget::radio::StyleSheet

active¶

The “active” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: RadioStyle

hovered¶

The “hovered” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: RadioStyle

pyiced.RuleStyle¶: alias of pyiced.RuleStyleSheet

class pyiced.RuleStyleSheet(proto=None, **kwargs)¶

The appearance of a rule().

Parameters

proto (Optional[RuleStyleSheet]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.
color (Color) – The color of the rule.
width (int) – The width (thickness) of the rule line.
radius (float) – The radius of the line corners.
fill_mode (FillMode) – The fill mode of the rule.

See also

color¶

The “color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

fill_mode¶

The “fill_mode” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: FillMode

radius¶

The “radius” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

width¶

The “width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

class pyiced.ScrollableStyleSheet(active, hovered=None, dragging=None)¶

The appearance of a scrollable().

Parameters

active (ScrollbarStyle) – Normal style of the scrollable.
hovered (Optional[ScrollbarStyle]) – Style of the scrollable when the cursor is hovering over it. Defaults to “active”.
dragging (Optional[ScrollbarStyle]) – Style of a scrollbar that is being dragged. Defaults to “hovered”.

See also

iced::widget::scrollable::StyleSheet

active¶

The “active” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: ScrollbarStyle

dragging¶

The “dragging” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: ScrollbarStyle

hovered¶

The “hovered” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: ScrollbarStyle

class pyiced.ScrollbarStyle(proto=None, **kwargs)¶

The appearance a specific state of a scrollable().

Parameters

proto (Optional[Union[ScrollbarStyle, str]]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.

The valid string values are “active”, “hovered” and “dragging”, same as the argument for ScrollableStyleSheet.

None is the same as “active”.
background (Optional[Color]) – The scrollbar’s background color.
border_radius (float) – The scrollbar’s border radius.
border_width (float) – The scrollbar’s border width.
border_color (Color) – The scrollbar’s border color.
scroller (ScrollerStyle) – The scroller of the scrollbar.

See also

iced_style::scrollable::Scrollbar

background¶

The “background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Optional[Color]

border_color¶

The “border_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_radius¶

The “border_radius” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

border_width¶

The “border_width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

scroller¶

The “scroller” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: ScrollerStyle

class pyiced.ScrollerStyle(proto=None, **kwargs)¶

The appearance of the scroller of a scrollable().

Parameters

proto (Optional[Union[ScrollerStyle, str]]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.

The valid string values are “active”, “hovered” and “dragging”, same as the argument for ScrollableStyleSheet.

None is the same as “active”.
color (Color) – The color of the scroller.
border_radius (float) – The border radius of the scroller.
border_width (float) – The border width of the scroller.
border_color (Color) – The border color of the scroller.

See also

iced_style::scrollable::Scroller

border_color¶

The “border_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_radius¶

The “border_radius” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

border_width¶

The “border_width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

color¶

The “color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

class pyiced.SliderStyle(proto=None, **kwargs)¶

The appearance of a slider() for some state.

Parameters

proto (Optional[Union[SliderStyle, str]]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.

The valid string values are “active”, “hovered” and “dragging”, same as the argument for SliderStyleSheet.

None is the same as “active”.
rail_colors (Tuple[Color, Color]) – Colors of the rail.
handle (SliderHandle) – Colors of the handle.

See also

iced::widget::slider::Style

handle¶

The “handle” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: SliderHandle

rail_colors¶

The “rail_colors” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Tuple[Color, Color]

class pyiced.SliderStyleSheet(active, hovered=None, dragging=None)¶

The appearance of a slider().

Parameters

active (SliderStyle) – Normal style of the slider.
hovered (Optional[SliderStyle]) – Style of the slider when the cursor is hovering over it. Defaults to “active”.
dragging (Optional[SliderStyle]) – Style of the slider is being dragged. Defaults to “hovered”.

See also

iced::widget::slider::StyleSheet

class pyiced.TextInputStyle(proto=None, **kwargs)¶

The appearance of a text_input() for some state.

Parameters

proto (Optional[Union[TextInputStyle, str]]) –
Source style sheet to clone and modify. Defaults to iced_style’s default style.

The valid string values are “active”, “focused” and “hovered”, same as the argument for TextInputStyleSheet.

None is the same as “active”.
background (Color) – The text_input’s background color.
border_radius (float) – The text_input’s border radius.
border_width (float) – The text_input’s border width.
border_color (Color) – The text_input’s border color.

See also

iced::widget::text_input::Style

background¶

The “background” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_color¶

The “border_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

border_radius¶

The “border_radius” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

border_width¶

The “border_width” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: float

class pyiced.TextInputStyleSheet(active, focused=None, hovered=None, placeholder_color=None, value_color=None, selection_color=None)¶

The appearance of a text_input().

Parameters

active (TextInputStyle) – Normal style of the text_input.
focused (Optional[TextInputStyle]) – Style of the text_input when the cursor is hovering over it. Defaults to “active”.
hovered (Optional[TextInputStyle]) – Style of the text_input is being dragged. Defaults to “focused”.
placeholder_color (Optional[Color]) – Text color of the placeholder text.
value_color (Optional[Color]) – Color of the text.
selection_color (Optional[Color]) – Color of the selection.

See also

iced::widget::text_input::StyleSheet

active¶

The “active” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: TextInputStyle

focused¶

The “focused” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: TextInputStyle

hovered¶

The “hovered” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: TextInputStyle

placeholder_color¶

The “placeholder_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

selection_color¶

The “selection_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

value_color¶

The “value_color” parameter given to the constructor.

Returns: The set, copied or defaulted value.
Return type: Color

pyiced.TooltipStyle¶: alias of pyiced.ContainerStyleSheet

pyiced.TooltipStyleSheet¶: alias of pyiced.ContainerStyleSheet