PyIced¶
Python bindings for Iced.
Iced is a cross-platform GUI library focused on simplicity and type-safety. Inspired by Elm.
Installation¶
$ pip install pyiced
To install from source you need to have a recent version of Rust installed in your $PATH.
Rustup is probably the most easy to use option to install and update Rust on your system.
Quick Example¶
A simple counter with two buttons to increment and decrement a value:
from pyiced import (
Align, button, ButtonState, column, container, IcedApp, Length, text,
)
class ExampleApp(IcedApp):
def __init__(self):
self.__incr_button_state = ButtonState()
self.__decr_button_state = ButtonState()
self.__value = 0
def title(self):
return 'Counter'
def view(self):
increment_button = button(
self.__incr_button_state, # To track the state across redraws.
text('Increment'), # This is content on the button.
on_press='incr', # This value is received in update().
)
value_label = text(f'{self.__value}', size=50)
decrement_button = button(
self.__decr_button_state,
text('Decrement'),
on_press='decr',
)
return container(
column([
increment_button,
value_label,
decrement_button,
]),
padding=20, align_x=Align.CENTER, align_y=Align.CENTER,
width=Length.FILL, height=Length.FILL,
)
def update(self, msg, clipboard):
# When an event occurs, this method is called.
# It can optionally return a list of async functions,
# to handle the event.
match msg:
case 'incr':
self.__value += 1
case 'decr':
self.__value -= 1
if __name__ == '__main__':
# This function only returns if there is an error on start-up.
# Otherwise the program gets terminated when the window is closed.
ExampleApp().run()
Table of Contents¶
Usage Examples¶
Quick Example¶
A simple counter with two buttons to increment and decrement a value:
from pyiced import (
Align, button, ButtonState, column, container, IcedApp, Length, text,
)
class ExampleApp(IcedApp):
def __init__(self):
self.__incr_button_state = ButtonState()
self.__decr_button_state = ButtonState()
self.__value = 0
def title(self):
return 'Counter'
def view(self):
increment_button = button(
self.__incr_button_state, # To track the state across redraws.
text('Increment'), # This is content on the button.
on_press='incr', # This value is received in update().
)
value_label = text(f'{self.__value}', size=50)
decrement_button = button(
self.__decr_button_state,
text('Decrement'),
on_press='decr',
)
return container(
column([
increment_button,
value_label,
decrement_button,
]),
padding=20, align_x=Align.CENTER, align_y=Align.CENTER,
width=Length.FILL, height=Length.FILL,
)
def update(self, msg, clipboard):
# When an event occurs, this method is called.
# It can optionally return a list of async functions,
# to handle the event.
match msg:
case 'incr':
self.__value += 1
case 'decr':
self.__value -= 1
if __name__ == '__main__':
# This function only returns if there is an error on start-up.
# Otherwise the program gets terminated when the window is closed.
ExampleApp().run()
Custom Styles¶
from pyiced import (
Align, button, ButtonState, ButtonStyle, Color, container,
ContainerStyle, IcedApp, Length, text,
)
class ButtonExample(IcedApp):
class settings:
class window:
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=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()
Asychronous Messages¶
new() and update() can either return a Message
(or a sequence of messages in the latter case), or
a coroutine / coroutines
to asynchronously generate a messages.
from asyncio import open_connection
from contextlib import closing
from pyiced import (
Align, Color, container, ContainerStyle, Font, IcedApp, Length, text,
)
class AsyncMessageExample(IcedApp):
def __init__(self):
self.__font = None
class settings:
class window:
size = (640, 320)
def title(self):
return 'Asynchronous Messages'
def new(self):
return [load_font()]
def update(self, msg, clipboard):
match msg:
case ('Font', font):
self.__font = font
def view(self):
return container(
text('Hello, world!', size=80, font=self.__font),
style=ContainerStyle(
text_color=Color(0.95, 0.87, 0.22),
background=Color(0.38, 0.60, 0.23),
),
padding=20, align_x=Align.CENTER, align_y=Align.CENTER,
width=Length.FILL, height=Length.FILL,
)
async def load_font():
FONT_NAME = 'Yellowtail'
FONT_HOST = 'fonts.cdnfonts.com'
FONT_PATH = '/s/16054/Yellowtail-Regular.ttf'
query = (
f"GET {FONT_PATH} HTTP/1.0\r\n"
f"Host: {FONT_HOST}\r\n"
f"Connection: closed\r\n"
f"\r\n"
).encode('US-ASCII')
reader, writer = await open_connection(FONT_HOST, 443, ssl=True)
with closing(writer):
writer.write(query)
await writer.drain()
while (await reader.readline()) != b'\r\n':
continue
data = await reader.read()
await writer.wait_closed()
return ('Font', Font(FONT_NAME, data))
if __name__ == '__main__':
AsyncMessageExample().run()
AsyncGenerator Generating Messages¶
An application can subscribe to AsyncGenerators
to receive Messages about asynchronously generated information, e.g. a pending web download.
from asyncio import sleep
from pyiced import column, IcedApp, stream, text
class StreamExample(IcedApp):
def __init__(self):
self.__stream = stream(self.__generator_func())
self.__index = 0
class settings:
class window:
size = (640, 40)
def title(self):
return 'Stream Example'
def view(self):
return column([text(f'Index: {self.__index / 10:.1f}')])
def subscriptions(self):
if self.__stream is not None:
return [self.__stream]
def update(self, msg, clipboard):
match msg:
case 'done':
self.__stream = None
case int(index):
self.__index = index
async def __generator_func(self):
for i in range(1, 101):
yield i
await sleep(0.1)
yield 'done'
if __name__ == '__main__':
StreamExample().run()
Capturing Keystrokes¶
To capture any keystoke (or indeed any event that original from user interaction),
you can make pyiced.IcedApp.subscriptions() return a list
[pyced.Subscription.UNCAPTURED].
from pyiced import (
Align, container, Message, IcedApp, Length, Subscription, text,
)
class FullscreenExample(IcedApp):
def __init__(self):
self.__fullscreen = False
self.__should_exit = False
class settings:
class window:
size = (640, 320)
def subscriptions(self):
return [Subscription.UNCAPTURED]
def fullscreen(self):
return self.__fullscreen
def should_exit(self):
return self.__should_exit
def title(self):
return self.__message
def update(self, msg, clipboard):
match msg:
case Message(keyboard='keyreleased', key_code='F11'):
self.__fullscreen = not self.__fullscreen
case Message(keyboard='keyreleased', key_code='Escape'):
self.__should_exit = True
def view(self):
return container(
text(self.__message, size=40),
padding=20, align_x=Align.CENTER, align_y=Align.CENTER,
width=Length.FILL, height=Length.FILL,
)
@property
def __message(self):
if self.__fullscreen:
return 'Fullscreen (press F11!)'
else:
return 'Windowed (press F11!)'
if __name__ == '__main__':
FullscreenExample().run()
Programming an IcedApp¶
Overview¶
|
|
A message generated through user interaction. |
|
|
|
Details¶
- class pyiced.IcedApp¶
-
- fullscreen()¶
True if the program should run in fullscreen mode.
The runtime will automatically transition your application if a new mode is returned.
- Return type
- new()¶
Initialize the application.
You can return
Commandsif you need to perform some async action in the background on startup. This is useful if you want to load state from a file, perform an initial HTTP request, etc.
- run(*, run=None)¶
Runs the application.
This method will take control of the current thread and will NOT return unless there is an error during startup.
It should probably be that last thing you call in your main function.
- scale_factor()¶
Returns the scale factor of the application.
It can be used to dynamically control the size of the UI at runtime (i.e. zooming).
For instance, a scale factor of 2.0 will make widgets twice as big, while a scale factor of 0.5 will shrink them to half their size.
- Return type
- property settings: Optional[pyiced.Settings]¶
The initial settings of the program.
Once queried once.
- should_exit()¶
Returns whether the application should be terminated.
This will kill the Python instance, too.
- Return type
- subscriptions()¶
Returns the event subscriptions for the current state of the application.
A subscription will be kept alive as long as you keep returning it, and the messages produced will be handled by update.
- Return type
- title()¶
The current title of the application.
This title can be dynamic! The runtime will automatically update the title of your application when necessary.
- Return type
- class pyiced.Element¶
- class pyiced.Message¶
A message generated through user interaction.
Messages get passed to to
update().- alt¶
The alt key was pressed / released.
- Returns
True – Yes, the alt key was pressed or released.
False – No, the state of the alt key is unchanged.
None – Not a “keypress”, “keyrelease” or “modifierschanged” event.
- Return type
Optional[bool]
- amount¶
The scroll movement.
- Returns
The horizontal and vertical amount. The unit can be determined by inspecting
wheelscrolled.None if not a scroll movement.
- Return type
- button¶
The button of a mouse event.
- characterreceived¶
A unicode character was received.
- Returns
The received, composed character. None if not a character event.
- Return type
Optional[str]
- control¶
The control key was pressed / released.
- Returns
True – Yes, the control key was pressed or released.
False – No, the state of the control key is unchanged.
None – Not a “keypress”, “keyrelease” or “modifierschanged” event.
- Return type
Optional[bool]
- cursormoved¶
The mouse cursor was moved
- file¶
The path of the hovering or dropped file.
- Returns
The path or none, if the Message is not a file action.
- Return type
Optional[pathlib.Path]
- finger¶
A unique identifier representing a finger on a touch interaction.
- Returns
Identifier of the finger.
- Return type
- key_code¶
The name of the pressed or released key.
See iced_native::keyboard::KeyCode for the name of the keys.
- Returns
The name of the key, or None if the not a key press or release.
- Return type
Optional[str]
- keyboard¶
The kind of the keyboard interaction.
- Returns
None if not a
Message(native="keyboard")interaction”keypressed” when a key was pushed down
”keyreleased” when a key no more pushed down
”characterreceived” when a key press + release generated a character
”modifierschanged” when a modifier was pressed or released, e.g. shift
- Return type
Optional[str]
- kind¶
The kind of the native message.
- Returns
“mouse” for mouse interactions, e.g. mouse clicking
”window” for window interactions, e.g. resizing
”keyboard” for keyboard interactions, e.g. key presses
”touch” for touch interactions (impossible?)
- Return type
- logo¶
The “logo” key was pressed / released.
The logo key is the windows key, command key, etc.
- Returns
True – Yes, the “logo” key was pressed or released.
False – No, the state of the “logo” key is unchanged.
None – Not a “keypress”, “keyrelease” or “modifierschanged” event.
- Return type
Optional[bool]
- mouse¶
A mouse event.
- Returns
“cursorentered” – The mouse cursor entered the window.
”cursorleft” – The mouse cursor left the window.
”cursormoved” – The mouse cursor was moved
”buttonpressed” – A mouse button was pressed.
”buttonreleased” – A mouse button was released.
”wheelscrolled” – The mouse wheel was scrolled.
None – Not a mouse event.
- Return type
Optional[str]
- resized¶
The new size of the window.
- shift¶
The shift key was pressed / released.
- Returns
True – Yes, the shift key was pressed or released.
False – No, the state of the shift key is unchanged.
None – Not a “keypress”, “keyrelease” or “modifierschanged” event.
- Return type
Optional[bool]
- touch¶
A touch interaction.
- Returns
“fingerpressed” – A touch interaction was started.
”fingermoved” – An on-going touch interaction was moved.
”fingerlifted” – A touch interaction was ended.
”fingerlost” – A touch interaction was canceled.
None – Not a touch interaction.
- Return type
Optional[str]
- wheelscrolled¶
The unit of the scroll movement.
- Returns
“lines” – Counting in lines / columns.
”pixels” – Counting in pixels.
None – Not a scroll movement.
- Return type
Optional[str]
- window¶
The kind of the window message.
- Returns
“resized” – The window was resized.
”closerequested” – The window close button was clicked.
”focused” – The window was focus.
”unfocused” – The focus left the window.
”filehovered” – A file is hovering the window. A selection of multiple files cause multiple messages.
”filedropped” – A file was dropped on the window. A selection of multiple files cause multiple messages.
”fileshoveredleft” – The cursor the with hovering file(s) left the window.
None – Not a window message.
- Return type
Optional[str]
- class pyiced.Settings¶
- property antialiasing: bool¶
If set to true, the renderer will try to perform antialiasing for some primitives.
Enabling it can produce a smoother result in some widgets, like the Canvas, at a performance cost.
- Return type
- property default_font: Optional[pyiced.Font]¶
The font that will be used by default.
If None or Font.DEFAULT is provided, a default system font will be chosen.
- property exit_on_close_request: bool¶
Whether the
IcedAppshould exit when the user requests the window to close (e.g. the user presses the close button).- Return type
- property window: Optional[pyiced.WindowSettings]¶
The window settings.
- Return type
- class pyiced.WindowSettings¶
- property always_on_top: bool¶
Whether the window will always be on top of other windows.
- Return type
- property decorations: bool¶
Whether the window should have a border, a title bar, etc. or not.
- Return type
Type aliases¶
Displayable Elements¶
Overview¶
|
A generic widget that produces a message when pressed. |
|
A box that can be checked. |
|
A container that distributes its contents vertically. |
|
Make a . |
|
A frame that displays an image while keeping aspect ratio. |
|
A widget for selecting a single value from a list of options. |
|
A bar that displays progress. |
|
A circular button representing a choice. |
|
A container that distributes its contents horizontally. |
|
Display a horizontal or vertical rule for dividing content. |
|
A widget that can vertically display an infinite amount of content with a scrollbar. |
|
An horizontal bar and a handle that selects a single value from a range of values. |
|
An amount of empty space. |
|
A vector graphics image. |
|
A paragraph of text. |
|
A field that can be filled with text. |
|
Make a tooltip. |
|
A |
Details¶
- pyiced.button(state, content, on_press=None, *, width=None, height=None, min_width=None, min_height=None, padding=None, style=None)¶
A generic widget that produces a message when pressed.
- Parameters
state (ButtonState) – Current state of the button. The same object must be given between calls.
content (Element) – The element displayed inside the button, e.g. a
text().on_press (Optional[object]) – Message to send to the app’s
update()loop when the key was clicked. Without this argument the button won’t be clickable.width (Optional[Length]) – Width the the button.
height (Optional[Length]) – Height the the button.
min_width (Optional[int]) – Minimum width of the button in pixels.
min_height (Optional[int]) – Minimum height of the button in pixels.
padding (Optional[int]) – Amount of pixels surrounding the contained element.
style (Optional[ButtonStyle]) – The style of the button.
- Returns
The newly created button.
- Return type
Example
from pyiced import ( Align, button, ButtonState, ButtonStyle, Color, container, ContainerStyle, IcedApp, Length, text, ) class ButtonExample(IcedApp): class settings: class window: 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=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()
See also
- pyiced.checkbox(is_checked, label, f=None, *, size=None, width=None, spacing=None, text_size=None, font=None, style=None)¶
A box that can be checked.
- Parameters
is_checked (bool) – Whether the checkbox is currently checked or not.
label (str) – A text besides the checkbox. Might be empty.
f (Optional[Callable[[bool], Optional[object]]]) –
Function to call when the checkbox is toggled. The argument is the new checked state.
The function can return a message that will be received in the app’s
update()loop.size (Optional[int]) – Size of the checkbox.
width (Optional[Length]) – Width of the widget (checkbox and text).
spacing (Optional[int]) – Space between checkbox and text.
text_size (Optional[int]) – Font size of the text.
font (Optional[Font]) – Font of the text.
style (Optional[CheckboxStyleSheet]) – Style of the checkbox.
- Returns
Newly created checkbox.
- Return type
Example
from pyiced import ( Align, checkbox, CheckboxStyle, CheckboxStyleSheet, Color, container, IcedApp, Length, ) class CheckboxExample(IcedApp): class settings: class window: size = (640, 320) def __init__(self): self.__is_checked = False def title(self): if self.__is_checked: return 'A checked checkbox' else: return 'A checkbox' def view(self): styled_checkbox = checkbox( self.__is_checked, self.title(), self.__set_checked, style=CheckboxStyleSheet( active=CheckboxStyle( 'active', background=Color(0.64, 0.41, 0.32), ), active_checked=CheckboxStyle( 'active_checked', background=Color(0, 0.71, 0.296), ), ), ) return container( styled_checkbox, padding=20, align_x=Align.CENTER, align_y=Align.CENTER, width=Length.FILL, height=Length.FILL, ) def __set_checked(self, value): self.__is_checked = value if __name__ == '__main__': CheckboxExample().run()
- pyiced.column(children, *, spacing=None, padding=None, width=None, height=None, max_width=None, max_height=None, align_items=None)¶
A container that distributes its contents vertically.
- Parameters
children (Iterable[Optional[Element]]) – Create the column with the given elements.
spacing (Optional[int]) – Vertical spacing between elements.
padding (Optional[int]) – Padding of the column.
width (Optional[Length]) – Width of the column.
height (Optional[Length]) – Height of the column.
max_width (Optional[int]) – Maximum width of the column.
max_height (Optional[int]) – Maximum height of the column in pixels.
align_items (Optional[Align]) – Horizontal alignment of the contents of the column.
- Returns
The newly created column.
- Return type
Example
from pyiced import column, IcedApp, text class ColumnExample(IcedApp): class settings: class window: size = (640, 320) def title(self): return 'A Column' def view(self): return column( [text('Hello,'), text('world!')], padding=80, spacing=120, ) if __name__ == '__main__': ColumnExample().run()
See also
- pyiced.container(content, *, padding=None, width=None, height=None, max_width=None, max_height=None, align_x=None, align_y=None, style=None)¶
Make a .
- Returns
The newly created .
- Return type
- pyiced.image(handle, *, width=None, height=None)¶
A frame that displays an image while keeping aspect ratio.
- Parameters
handle (ImageHandle) – The handle of the image.
width (Optional[Length]) – The width of the image.
heigth (Optional[Length]) – The height of the image.
- Returns
The newly created image element.
- Return type
Example
from asyncio import open_connection from contextlib import closing from pyiced import Align, container, IcedApp, image, ImageHandle, Length, text class ImageExample(IcedApp): def __init__(self): self.__handle = None class settings: class window: size = (640, 320) def title(self): return 'An Image' def new(self): return load_image() def update(self, msg, clipboard): match msg: case ('ImageHandle', handle): self.__handle = handle def view(self): if self.__handle is None: return text('Loading …') return container( image( self.__handle, height=Length.units(300), width=Length.units(600), # the aspect ratio is preserved ), align_x=Align.CENTER, align_y=Align.CENTER, width=Length.FILL, height=Length.FILL, ) async def load_image(): HOST = 'upload.wikimedia.org' PATH = '/wikipedia/de/b/bb/Png-logo.png' query = ( f"GET {PATH} HTTP/1.0\r\n" f"Host: {HOST}\r\n" f"Connection: closed\r\n" f"User-Agent: Mozilla/1.22 (compatible; MSIE 2.0; Windows 95)\r\n" f"\r\n" ).encode('US-ASCII') reader, writer = await open_connection(HOST, 443, ssl=True) with closing(writer): writer.write(query) await writer.drain() while (await reader.readline()) != b'\r\n': continue data = await reader.read() await writer.wait_closed() return ('ImageHandle', ImageHandle.from_memory(data)) if __name__ == '__main__': ImageExample().run()
See also
- pyiced.no_element(content, *, padding=None, width=None, height=None, max_width=None, max_height=None, align_x=None, align_y=None)¶
A
space()with minimum width and height.You should never actually need to use this function is code.
- Returns
The newly created empty space.
- Return type
- pyiced.pick_list(state, options, selected, on_selected, *, text_size=None, font=None, style=None)¶
A widget for selecting a single value from a list of options.
- Parameters
state (PickListState) – Current state of the pick list. The same object must be given between calls.
options (Iterable[Optional[str]]) – Values to select from.
selected (Optional[str]) – The currently selected value.
on_selected (Callable[[str], Optional[object]]) –
Function to call when a new value was selected.
The function can return a message that will be received in the app’s
update()loop.text_size (Optional[int]) – The text size of the pick list.
font (Optional[Font]) – Font of the pick list.
style (Optional[PickListStyle]) – Style of the pick list.
- Returns
The newly created pick list.
- Return type
Example
from asyncio import sleep from pyiced import ( Align, container, IcedApp, Length, pick_list, PickListState, text, ) class PickListExample(IcedApp): class settings: class window: size = (640, 320) def __init__(self): self.__pick_list_state = PickListState() self.__selected = None self.__enabled = True def title(self): return 'A Pick List' def view(self): if self.__enabled: element = pick_list( self.__pick_list_state, ['Python', 'Rust', 'both', 'neither'], self.__selected, self.__select, ) else: element = text(':-(') return container( element, padding=20, align_x=Align.CENTER, align_y=Align.CENTER, width=Length.FILL, height=Length.FILL, ) def update(self, msg, clipboard): match msg: case 'enable': self.__enabled = True case 'disable': self.__enabled = False return [reenable()] def __select(self, value): if value == 'neither': self.__selected = None return 'disable' self.__selected = value async def reenable(): await sleep(2.0) return 'enable' if __name__ == '__main__': PickListExample().run()
- pyiced.progress_bar(start, end, value, *, width=None, height=None, style=None)¶
A bar that displays progress.
- Parameters
start (float) – Minimum value inside the value range.
end (float) – Maximum value inside the value range.
value (float) – Current value of the progress bar.
width (Optional[Length]) – Width of the progress bar.
height (Optional[Length]) – Height of the progress bar.
style (Optional[ProgressBarStyleSheet]) – Style of the progress bar.
- Returns
The newly created progress bar.
- Return type
Example
from datetime import timedelta from pyiced import Align, container, every, IcedApp, Length, progress_bar class ProgressBarExample(IcedApp): class settings: class window: size = (640, 320) def __init__(self): self.__value = 0.0 def title(self): return 'A Progress Bar' def subscriptions(self): if self.__value < 1: return [every(timedelta(milliseconds=10), 'progress')] def update(self, msg, clipboard): match msg: case ('progress', _): self.__value = (self.__value + 0.001) def view(self): return container( progress_bar(0, 1, self.__value), padding=20, align_x=Align.CENTER, align_y=Align.CENTER, width=Length.FILL, height=Length.FILL, ) if __name__ == '__main__': ProgressBarExample().run()
- pyiced.radio(value, label, selected, f, *, size=None, width=None, spacing=None, text_size=None)¶
A circular button representing a choice.
- Parameters
value (int) – Identifier of the option.
label (str) – Label next to the radio button.
selected (Optional[int]) – The identifier of the currently selected option.
f (Callable[[int], Optional[object]]) –
Function to call with the value as argument if the radio was selected. The call may update selected for the next call, or it can be ignored, e.g. if the select is invalid.
The function can return a message that will be received in the app’s
update()loop.size (Optional[int]) – The diameter of the circle.
width (Optional[Length]) – The width including the text.
spacing (Optional[int]) – The spacing between the radio button and its text.
text_size (Optional[int]) – The size of the text.
style (Optional[RadioStyleSheet]) – Style of the radio button.
- Returns
The newly created radio button.
- Return type
See also
- pyiced.row(children, *, spacing=None, padding=None, width=None, height=None, max_width=None, max_height=None, align_items=None)¶
A container that distributes its contents horizontally.
- Parameters
children (Iterable[Optional[Element]]) – Create the row with the given elements.
spacing (Optional[int]) – Sets the horizontal spacing between elements.
padding (Optional[int]) – Padding of the row.
width (Optional[Length]) – Width of the row.
height (Optional[Length]) – Height of the row.
max_width (Optional[int]) – Maximum width of the row.
max_height (Optional[int]) – Maximum height of the row.
align_items (Optional[Align]) – Vertical alignment of the contents of the row.
- Returns
The newly created row.
- Return type
Example
from pyiced import IcedApp, row, text class RowExample(IcedApp): class settings: class window: size = (640, 320) def title(self): return 'A Row' def view(self): return row( [text('Hello,'), text('world!')], padding=120, spacing=80, ) if __name__ == '__main__': RowExample().run()
See also
- pyiced.rule(*, horizontal=0, vertical=0, style=None)¶
Display a horizontal or vertical rule for dividing content.
- Parameters
horizontal (Optional[int]) – Creates a horizontal rule for dividing content by the given vertical spacing.
vertical (Optional[int]) – Creates a vertical rule for dividing content by the given horizontal spacing.
style (Optional[RuleStyleSheet]) – The style of the rule.
- Returns
The newly created divider.
- Return type
See also
- pyiced.scrollable(state, children, *, spacing=None, padding=None, width=None, height=None, max_width=None, max_heigth=None, align_items=None, scrollbar_width=None, scrollbar_margin=None, scroller_width=None, style=None)¶
A widget that can vertically display an infinite amount of content with a scrollbar.
- Parameters
state (ScrollableState) – Current state of the scroll container. The same object must be given between calls.
children (Iterator[Optional[Element]]) – Elements of the scrollable
column().spacing (Optional[int]) – Vertical spacing between elements.
padding (Optional[int]) – Padding of the Scrollable.
width (Optional[Length]) – Width of the scrollable.
height (Optional[Length]) – Height of the scrollable.
max_width (Optional[int]) – Maximum width of the scrollable.
max_height (Optional[int]) – Maximum height of the scrollable in pixels.
align_items (Optional[Align]) – Horizontal alignment of the contents of the scrollable.
scrollbar_width (Optional[int]) – Scrollbar width of the Scrollable. Silently enforces a minimum value of 1.
scrollbar_margin (Optional[int]) – Scrollbar margin of the scrollable.
scroller_width (Optional[int]) – Scroller width of the scrollable. Silently enforces a minimum value of 1.
style (Optional[ScrollableStyleSheet]) – The style of the scrollable.
- Returns
The newly created scrollable widget.
- Return type
- pyiced.slider(state, start, end, value, on_change, *, on_release=None, width=None, height=None, step=1.0, style=None)¶
An horizontal bar and a handle that selects a single value from a range of values.
- Parameters
state (SliderState) – Current state of the slider. The same object must be given between calls.
start (float) – Smallest value inside the range.
end (float) – Biggest value inside the range.
value (float) – Current value.
on_change (Callable[[float], Optional[object]]) –
Function to call with the new value.
The function can return a message that will be received in the app’s
update()loop.on_release (Optional[object]) –
Sets the release message of the Slider. This is called when the mouse is released from the slider.
Typically, the user’s interaction with the slider is finished when this message is produced. This is useful if you need to spawn a long-running task from the slider’s result, where the default on_change message could create too many events.
width (Optional[Length]) – Width of the slider.
height (Optional[int]) – Height of the slider.
step (float) – Step size of the slider.
style (SliderStyleSheet) – The normal style of the slider.
- Returns
The newly created .
- Return type
See also
- pyiced.space(*, width=None, height=None)¶
An amount of empty space.
It can be useful if you want to fill some space with nothing.
- Parameters
- Returns
The newly created .
- Return type
See also
- pyiced.svg(handle, *, width=None, height=None)¶
A vector graphics image.
An SVG image resizes smoothly without losing any quality.
SVG images can have a considerable rendering cost when resized, specially when they are complex.
- Parameters
- Returns
The newly created SVG image.
- Return type
Example
from asyncio import open_connection from contextlib import closing from pyiced import Align, container, IcedApp, Length, svg, SvgHandle, text class SvgExample(IcedApp): def __init__(self): self.__handle = None class settings: class window: size = (640, 320) def title(self): return 'An SVG' def new(self): return load_svg() def update(self, msg, clipboard): match msg: case ('SvgHandle', handle): self.__handle = handle def view(self): if self.__handle is None: return text('Loading …') return container( svg( self.__handle, height=Length.units(300), width=Length.units(300), ), align_x=Align.CENTER, align_y=Align.CENTER, width=Length.FILL, height=Length.FILL, ) async def load_svg(): HOST = 'raw.githubusercontent.com' PATH = '/iced-rs/iced/master/docs/logo.svg' query = ( f"GET {PATH} HTTP/1.0\r\n" f"Host: {HOST}\r\n" f"Connection: closed\r\n" f"User-Agent: Mozilla/1.22 (compatible; MSIE 2.0; Windows 95)\r\n" f"\r\n" ).encode('US-ASCII') reader, writer = await open_connection(HOST, 443, ssl=True) with closing(writer): writer.write(query) await writer.drain() while (await reader.readline()) != b'\r\n': continue data = await reader.read() await writer.wait_closed() return ('SvgHandle', SvgHandle.from_memory(data)) if __name__ == '__main__': SvgExample().run()
See also
- pyiced.text(label, *, size=None, color=None, font=None, width=None, height=None, horizontal_alignment=None, vertical_alignment=None)¶
A paragraph of text.
- Parameters
label (str) – The text to display.
size (Optional[int]) – The size of the text.
color (Optional[Color]) – The color of the text.
font (Optional[Font]) – The Font of the text.
width (Optional[Length]) – The width of the text boundaries
height (Optional[Length]) – The height of the text boundaries
horizontal_alignment (Optional[HorizontalAlignment]) – The horizontal alignment of the text.
vertical_alignment (Optional[VerticalAlignment]) – The vertical alignment of the Text
- Returns
The newly created text label.
- Return type
See also
- pyiced.text_input(state, placeholder, value, on_change, *, font=None, width=None, max_width=None, padding=None, size=None, on_submit=None, password=False)¶
A field that can be filled with text.
- Parameters
state (TextInputState) – Current state of the input element. The same object must be given between calls.
placeholder (str) – Placeholder text for an element input.
value (str) – Current value of the input element.
on_change (Callable[[str], Optional[object]]) –
Function to call when the text was changed. The new text is the argument of the callback function. The new text should be value for argument “value”, but you may reject the new text if it does not fit some criteria defined by you.
The function can return a message that will be received in the app’s
update()loop.font (Optional[Font]) – The font of the text.
width (Optional[Length]) – The width of the input element.
max_width (Optional[int]) – The maximum width of the input element.
padding (Optional[int]) – The padding of the input element.
size (Optional[int]) – The text size of the input element.
on_submit (Optional[object]) – Message to send to
pyiced.IcedApp.update()if Enter was pressed.password (bool) – If set to True, the input element becomes a secure password input.
- Returns
The newly created text input element.
- Return type
- pyiced.tooltip(content, tooltip, position, *, font, gap, padding)¶
Make a tooltip.
- Parameters
content (Element) – Contained element that has a tooltip.
tooltip (str) – Tooltip text to display.
position (TooltipPosition) – The position of the tooltip.
size (Optional[int]) – The size of the text of the tooltip.
font (Optional[Font]) – The font of the tooltip.
gap (Optional[int]) – The gap between the content and its tooltip.
padding (Optional[int]) –
- Returns
The newly created tooltip.
- Return type
State Objects¶
To keep the state of an Element across multiple invocations of
view(), e.g. the cursor position in a
text_input(), you have to supply a state object.
Warning
If the same state object is used for multiple elements in the same
view() call, only the first element get displayed.
All and further elements with the same state become no_element().
Overview¶
The state of a |
|
The state of a |
|
The state of a |
|
The state of a |
|
The state of a |
Details¶
- class pyiced.PickListState¶
The state of a
pick_list().
- class pyiced.ScrollableState¶
The state of a
scrollable().Warning
If the state is currently in use, calling its methods will fail.
- is_scroll_box_touched()¶
Returns whether the scroll box is currently touched or not.
- Returns
Yes or no
- Return type
- is_scroller_grabbed()¶
Returns whether the scroller is currently grabbed or not.
- Returns
Yes or no
- Return type
- offset(bounds, content_bounds)¶
The current scrolling offset of the ScrollableState, given the bounds of the Scrollable and its contents.
- scroll(delta_y, bounds, content_bounds)¶
Apply a scrolling offset to the current ScrollableState, given the bounds of the Scrollable and its contents.
- scroll_to(percentage, bounds, content_bounds)¶
Moves the scroll position to a relative amount, given the bounds of the Scrollable and its contents.
0.0 represents scrollbar at the top, while 1.0 represents scrollbar at the bottom.
- class pyiced.TextInputState¶
The state of a
text_input().- focus()¶
Focuses the
text_input().Warning
If the state is currently in use, the method will fail.
- is_focused()¶
Returns whether the
text_input()is currently focused or not.Warning
If the state is currently in use, the method will fail.
- Returns
Yes or no
- Return type
- move_cursor_to(position)¶
Moves the
TextInputCursor()of theTextInputto an arbitrary location.The result is measured in terms of graphems, not bytes or codepoints!
See also
Warning
If the state is currently in use, the method will fail.
- Parameters
position (int) – The new cursor position.
- move_cursor_to_end()¶
Moves the
TextInputCursor()of theTextInputto the end of the input text.Warning
If the state is currently in use, the method will fail.
- move_cursor_to_front()¶
Moves the
TextInputCursor()of theTextInputto the front of the input text.Warning
If the state is currently in use, the method will fail.
- selection(value)¶
Get the selected text.
Warning
If the state is currently in use, the method will fail.
- Parameters
value (str) – The current value of the
text_input().- Returns
The selected text. May be empty.
- Return type
- state(value)¶
Get the state of the
TextInputCursor().The result is measured in terms of graphems, not bytes or codepoints!
Warning
If the state is currently in use, the method will fail.
- Returns
int – The current cursor position when there’s no selection.
Tuple[int, int] – The selected text range.
- unfocus()¶
Unfocuses the
text_input().Warning
If the state is currently in use, the method will fail.
Values and Enums¶
Overview¶
Alignment on an axis of a container. |
|
A buffer for short-term storage and transfer within and between applications. |
|
|
A color in the sRGB color space. |
The fill mode of a rule. |
|
|
A font. |
The horizontal alignment of some resource. |
|
An |
|
|
A measurement of a monotonically nondecreasing clock. |
The strategy used to fill space in a specific dimension. |
|
|
A line. |
|
A 2D point. |
|
A rectangle. |
|
An amount of space in 2 dimensions. |
|
The appearance of the handle of a slider. |
The shape of the handle of a slider. |
|
An |
|
|
A representation of cursor position in a |
The position of the tooltip. |
|
The vertical alignment of some resource. |
Details¶
- class pyiced.Align¶
Alignment on an axis of a container.
See also
- START¶
Align at the start of the axis.
- CENTER¶
Align at the center of the axis.
- END¶
Align at the end of the axis.
- class pyiced.Clipboard¶
A buffer for short-term storage and transfer within and between applications.
Warning
The clipboard is only valid during the call to
pyiced.IcedApp.update().See also
- class pyiced.Color(r, g, b, a=1.0)¶
A color in the sRGB color space.
- Parameters
- BLACK = Color(0, 0, 0)¶
- TRANSPARENT = Color(0, 0, 0, a=0)¶
- WHITE = Color(1, 1, 1)¶
- a¶
Alpha channel, 0.0 – 1.0 (0.0 = transparent; 1.0 = opaque)
- Returns
Color channel value
- Return type
- class pyiced.FillMode¶
The fill mode of a rule.
See also
- FULL = FillMode.FULL¶
- static asymmetric_padding(first_pad, second_pad)¶
Different offset on each end of the rule.
- class pyiced.Font(name, data)¶
A font.
The font does not get loaded multiple times, but instead the name is used to tell fonts apart. So you should use the same name for the same data in subsequent Font instance creations.
- Parameters
name (str) – The name of the external font
data (bytes-like) – The bytes of the external font
See also
Warning
The font data gets interned! Even of the module is unloaded / reloaded, some memory is lost until the interpreter is restarted.
- DEFAULT = Font.DEFAULT¶
- class pyiced.HorizontalAlignment¶
The horizontal alignment of some resource.
See also
- LEFT¶
Align left
- CENTER¶
Horizontally centered
- RIGHT¶
Align right
- class pyiced.ImageHandle¶
An
pyiced.image()handle.See also
- static from_memory(bytes)¶
Creates an image handle containing the image data directly.
- Parameters
bytes (bytes-like) – The data of the image file.
- Returns
The new image handle.
- Return type
- static from_path(path)¶
Creates an image handle pointing to the image of the given path.
- Parameters
path (pathlib.Path) – The path of the image file.
- Returns
The new image handle.
- Return type
- class pyiced.Instant¶
A measurement of a monotonically nondecreasing clock. Opaque and useful only with duration.
You can add/substract a number of seconds as
floatto/from an instant to get a new instant.You can add/substract a
timedeltato/from an instant to get a new instant.You can substract two instants to get the number of seconds as
floatbetween them:later - earlier = seconds.
See also
- class pyiced.Length¶
The strategy used to fill space in a specific dimension.
See also
- FILL = Length.FILL¶
- SHRINK = Length.SHRINK¶
- static fill_portion(i)¶
Fill a portion of the remaining space relative to other elements.
- static units(i)¶
Fill a fixed amount of space.
- class pyiced.Line(color, width)¶
A line.
It is normally used to define the highlight of something, like a split.
See also
- color¶
The color of the line.
- Returns
The “color” parameter given when constructing this line.
- Return type
- class pyiced.Point(x, y)¶
A 2D point.
See also
- ORIGIN = Point(0, 0)¶
- x¶
The X coordinate.
- Returns
The “x” parameter given when constructing this point.
- Return type
- class pyiced.Rectangle(top_left, size)¶
A rectangle.
See also
- height¶
Height of the rectangle.
- Returns
The “size.height” parameter given when constructing this point.
- Return type
- size¶
The size of the rectangle.
- Returns
The “size” parameter given when constructing this point.
- Return type
- top_left¶
The top-left corner.
- Returns
The “top_left” parameter given when constructing this point.
- Return type
- width¶
Width of the rectangle.
- Returns
The “size.width” parameter given when constructing this point.
- Return type
- static with_size(size)¶
Creates a new Rectangle with its top-left corner at the origin and with the provided Size.
- x¶
X coordinate of the top-left corner.
- Returns
The “top_left.x” parameter given when constructing this point.
- Return type
- class pyiced.Size(width, height)¶
An amount of space in 2 dimensions.
See also
- INFINITY = Size(inf, inf)¶
- UNIT = Size(1.0, 1.0)¶
- ZERO = Size(0.0, 0.0)¶
- height¶
The height.
- Returns
The “height” parameter given when constructing this size.
- Return type
- class pyiced.SliderHandle(shape, color, border_width, border_color)¶
The appearance of the handle of a slider.
- Parameters
shape (SliderHandleShape) – The color of the slider_handle.
color (Color) – The width of the slider_handle.
border_width (float) – The width of the slider_handle.
border_color (Color) – The width of the slider_handle.
See also
- class pyiced.SliderHandleShape¶
The shape of the handle of a slider.
See also
- static circle(radius)¶
A circle.
- Parameters
radius (float) – The radius of the circle
- Returns
A slider handle in the shape of a circle.
- Return type
- static rectangle(width, border_radius)¶
A rectangle.
- Parameters
- Returns
A slider handle in the shape of a rectangle.
- Return type
- class pyiced.SvgHandle¶
An
svg()handle.See also
- static from_memory(bytes)¶
Creates an SVG Handle pointing to the vector image of the given path.
- Parameters
bytes (bytes-like) –
Creates an SVG Handle from raw bytes containing either an SVG string or gzip compressed data.
This is useful if you already have your SVG data in-memory, maybe because you downloaded or generated it procedurally.
- Returns
An SVG handle usable in
svg().- Return type
- class pyiced.TextInputCursor(state)¶
A representation of cursor position in a
text_input().There should be no reason to create or inspect this object directly.
- Parameters
state (TextInputState) – Text input state to inspect.
- selection(value)¶
Get the selected text.
Warning
If the state is currently in use, the method will fail.
- Parameters
value (str) – The current value of the
text_input().- Returns
The selected text. May be empty.
- Return type
- state(value)¶
Get the state of the
TextInputCursor().The result is measured in terms of graphems, not bytes or codepoints!
Warning
If the state is currently in use, the method will fail.
- Returns
int – The current cursor position when there’s no selection.
Tuple[int, int] – The selected text range.
- class pyiced.TooltipPosition¶
The position of the tooltip.
See also
- FOLLOW_CURSOR¶
The tooltip will follow the cursor.
- TOP¶
The tooltip will appear on the top of the widget.
- BOTTOM¶
The tooltip will appear on the bottom of the widget.
- LEFT¶
The tooltip will appear on the left of the widget.
- RIGHT¶
The tooltip will appear on the right of the widget.
Named Colors¶
pyiced.css_color exports pyiced.Color constants for all 148 named
CSS Color Module Level 4
colors.
- pyiced.css_color.ALICEBLUE¶
- pyiced.css_color.ANTIQUEWHITE¶
- pyiced.css_color.AQUA¶
- pyiced.css_color.AQUAMARINE¶
- pyiced.css_color.AZURE¶
- pyiced.css_color.BEIGE¶
- pyiced.css_color.BISQUE¶
- pyiced.css_color.BLACK¶
- pyiced.css_color.BLANCHEDALMOND¶
- pyiced.css_color.BLUE¶
- pyiced.css_color.BLUEVIOLET¶
- pyiced.css_color.BROWN¶
- pyiced.css_color.BURLYWOOD¶
- pyiced.css_color.CADETBLUE¶
- pyiced.css_color.CHARTREUSE¶
- pyiced.css_color.CHOCOLATE¶
- pyiced.css_color.CORAL¶
- pyiced.css_color.CORNFLOWERBLUE¶
- pyiced.css_color.CORNSILK¶
- pyiced.css_color.CRIMSON¶
- pyiced.css_color.CYAN¶
- pyiced.css_color.DARKBLUE¶
- pyiced.css_color.DARKCYAN¶
- pyiced.css_color.DARKGOLDENROD¶
- pyiced.css_color.DARKGRAY¶
- pyiced.css_color.DARKGREEN¶
- pyiced.css_color.DARKGREY¶
- pyiced.css_color.DARKKHAKI¶
- pyiced.css_color.DARKMAGENTA¶
- pyiced.css_color.DARKOLIVEGREEN¶
- pyiced.css_color.DARKORANGE¶
- pyiced.css_color.DARKORCHID¶
- pyiced.css_color.DARKRED¶
- pyiced.css_color.DARKSALMON¶
- pyiced.css_color.DARKSEAGREEN¶
- pyiced.css_color.DARKSLATEBLUE¶
- pyiced.css_color.DARKSLATEGRAY¶
- pyiced.css_color.DARKSLATEGREY¶
- pyiced.css_color.DARKTURQUOISE¶
- pyiced.css_color.DARKVIOLET¶
- pyiced.css_color.DEEPPINK¶
- pyiced.css_color.DEEPSKYBLUE¶
- pyiced.css_color.DIMGRAY¶
- pyiced.css_color.DIMGREY¶
- pyiced.css_color.DODGERBLUE¶
- pyiced.css_color.FIREBRICK¶
- pyiced.css_color.FLORALWHITE¶
- pyiced.css_color.FORESTGREEN¶
- pyiced.css_color.FUCHSIA¶
- pyiced.css_color.GAINSBORO¶
- pyiced.css_color.GHOSTWHITE¶
- pyiced.css_color.GOLD¶
- pyiced.css_color.GOLDENROD¶
- pyiced.css_color.GRAY¶
- pyiced.css_color.GREEN¶
- pyiced.css_color.GREENYELLOW¶
- pyiced.css_color.GREY¶
- pyiced.css_color.HONEYDEW¶
- pyiced.css_color.HOTPINK¶
- pyiced.css_color.INDIANRED¶
- pyiced.css_color.INDIGO¶
- pyiced.css_color.IVORY¶
- pyiced.css_color.KHAKI¶
- pyiced.css_color.LAVENDER¶
- pyiced.css_color.LAVENDERBLUSH¶
- pyiced.css_color.LAWNGREEN¶
- pyiced.css_color.LEMONCHIFFON¶
- pyiced.css_color.LIGHTBLUE¶
- pyiced.css_color.LIGHTCORAL¶
- pyiced.css_color.LIGHTCYAN¶
- pyiced.css_color.LIGHTGOLDENRODYELLOW¶
- pyiced.css_color.LIGHTGRAY¶
- pyiced.css_color.LIGHTGREEN¶
- pyiced.css_color.LIGHTGREY¶
- pyiced.css_color.LIGHTPINK¶
- pyiced.css_color.LIGHTSALMON¶
- pyiced.css_color.LIGHTSEAGREEN¶
- pyiced.css_color.LIGHTSKYBLUE¶
- pyiced.css_color.LIGHTSLATEGRAY¶
- pyiced.css_color.LIGHTSLATEGREY¶
- pyiced.css_color.LIGHTSTEELBLUE¶
- pyiced.css_color.LIGHTYELLOW¶
- pyiced.css_color.LIME¶
- pyiced.css_color.LIMEGREEN¶
- pyiced.css_color.LINEN¶
- pyiced.css_color.MAGENTA¶
- pyiced.css_color.MAROON¶
- pyiced.css_color.MEDIUMAQUAMARINE¶
- pyiced.css_color.MEDIUMBLUE¶
- pyiced.css_color.MEDIUMORCHID¶
- pyiced.css_color.MEDIUMPURPLE¶
- pyiced.css_color.MEDIUMSEAGREEN¶
- pyiced.css_color.MEDIUMSLATEBLUE¶
- pyiced.css_color.MEDIUMSPRINGGREEN¶
- pyiced.css_color.MEDIUMTURQUOISE¶
- pyiced.css_color.MEDIUMVIOLETRED¶
- pyiced.css_color.MIDNIGHTBLUE¶
- pyiced.css_color.MINTCREAM¶
- pyiced.css_color.MISTYROSE¶
- pyiced.css_color.MOCCASIN¶
- pyiced.css_color.NAVAJOWHITE¶
- pyiced.css_color.NAVY¶
- pyiced.css_color.OLDLACE¶
- pyiced.css_color.OLIVE¶
- pyiced.css_color.OLIVEDRAB¶
- pyiced.css_color.ORANGE¶
- pyiced.css_color.ORANGERED¶
- pyiced.css_color.ORCHID¶
- pyiced.css_color.PALEGOLDENROD¶
- pyiced.css_color.PALEGREEN¶
- pyiced.css_color.PALETURQUOISE¶
- pyiced.css_color.PALEVIOLETRED¶
- pyiced.css_color.PAPAYAWHIP¶
- pyiced.css_color.PEACHPUFF¶
- pyiced.css_color.PERU¶
- pyiced.css_color.PINK¶
- pyiced.css_color.PLUM¶
- pyiced.css_color.POWDERBLUE¶
- pyiced.css_color.PURPLE¶
- pyiced.css_color.REBECCAPURPLE¶
- pyiced.css_color.RED¶
- pyiced.css_color.ROSYBROWN¶
- pyiced.css_color.ROYALBLUE¶
- pyiced.css_color.SADDLEBROWN¶
- pyiced.css_color.SALMON¶
- pyiced.css_color.SANDYBROWN¶
- pyiced.css_color.SEAGREEN¶
- pyiced.css_color.SEASHELL¶
- pyiced.css_color.SIENNA¶
- pyiced.css_color.SILVER¶
- pyiced.css_color.SKYBLUE¶
- pyiced.css_color.SLATEBLUE¶
- pyiced.css_color.SLATEGRAY¶
- pyiced.css_color.SLATEGREY¶
- pyiced.css_color.SNOW¶
- pyiced.css_color.SPRINGGREEN¶
- pyiced.css_color.STEELBLUE¶
- pyiced.css_color.TAN¶
- pyiced.css_color.TEAL¶
- pyiced.css_color.THISTLE¶
- pyiced.css_color.TOMATO¶
- pyiced.css_color.TURQUOISE¶
- pyiced.css_color.VIOLET¶
- pyiced.css_color.WHEAT¶
- pyiced.css_color.WHITE¶
- pyiced.css_color.WHITESMOKE¶
- pyiced.css_color.YELLOW¶
- pyiced.css_color.YELLOWGREEN¶
Element Styles¶
Overview¶
alias of |
|
|
The appearance of a button. |
|
The appearance of a checkbox for some state. |
|
The appearance of a checkbox. |
alias of |
|
|
The appearance of a container. |
alias of |
|
|
The appearance of a pane_grid. |
|
The appearance of a pick list menu. |
|
The appearance of a pick list for some state. |
|
The appearance of a pick list. |
alias of |
|
|
The appearance of a progress_bar. |
|
The appearance of a radio button for some state. |
|
The appearance of a radio. |
alias of |
|
|
The appearance of a rule. |
|
The appearance of a |
|
The appearance a specific state of a |
|
The appearance of the scroller of a |
|
The appearance of a slider for some state. |
|
The appearance of a slider. |
|
The appearance of a |
|
The appearance of a |
Quick Example¶
from pyiced import (
Align, button, ButtonState, ButtonStyle, Color, container,
ContainerStyle, IcedApp, Length, text,
)
class ButtonExample(IcedApp):
class settings:
class window:
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=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¶
- pyiced.ButtonStyle¶
alias of
pyiced.ButtonStyleSheet
- class pyiced.ButtonStyleSheet(proto=None, **kwargs)¶
The appearance of a button.
- 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.
- 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
- border_radius¶
The “border_radius” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_width¶
The “border_width” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- background¶
The “background” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_color¶
The “border_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_radius¶
The “border_radius” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_width¶
The “border_width” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- active¶
The “active” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- active_checked¶
The “active_checked” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- hovered¶
The “hovered” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- hovered_checked¶
The “hovered_checked” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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.
- 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
- border_radius¶
The “border_radius” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_width¶
The “border_width” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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.
- 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
- background¶
The “background” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_color¶
The “border_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_width¶
The “border_width” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- selected_background¶
The “selected_background” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- selected_text_color¶
The “selected_text_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- background¶
The “background” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_color¶
The “border_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_radius¶
The “border_radius” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_width¶
The “border_width” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- icon_size¶
The “icon_size” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- active¶
The “active” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- hovered¶
The “hovered” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
The “menu” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- pyiced.ProgressBarStyle¶
alias of
pyiced.ProgressBarStyleSheet
- class pyiced.ProgressBarStyleSheet(proto=None, **kwargs)¶
The appearance of a progress_bar.
- Parameters
- background¶
The “background” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- bar¶
The “bar” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- class pyiced.RadioStyle(proto=None, **kwargs)¶
The appearance of a radio button 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
- background¶
The “background” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_color¶
The “border_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_width¶
The “border_width” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- active¶
The “active” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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.
- color¶
The “color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- fill_mode¶
The “fill_mode” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- radius¶
The “radius” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- class pyiced.ScrollableStyleSheet(active, hovered=None, dragging=None)¶
The appearance of a
scrollable().- Parameters
active (ScrollableStyle) – Normal style of the scrollable.
hovered (Optional[ScrollableStyle]) – Style of the scrollable when the cursor is hovering over it. Defaults to “active”.
dragging (Optional[ScrollableStyle]) – Style of a scrollbar that is being dragged. Defaults to “hovered”.
See also
- active¶
The “active” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- dragging¶
The “dragging” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- hovered¶
The “hovered” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- 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
- border_radius¶
The “border_radius” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_width¶
The “border_width” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- scroller¶
The “scroller” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- border_color¶
The “border_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_radius¶
The “border_radius” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_width¶
The “border_width” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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”.
handle (SliderHandle) – TODO
See also
- handle¶
The “handle” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- 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
- background¶
The “background” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_color¶
The “border_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- border_radius¶
The “border_radius” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- 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
- active¶
The “active” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- focused¶
The “focused” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- hovered¶
The “hovered” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- placeholder_color¶
The “placeholder_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
- selection_color¶
The “selection_color” parameter given to the constructor.
- Returns
The set, copied or defaulted value.
- Return type
Event Listening¶
Overview¶
|
Returns a |
TODO |
|
TODO |
Details¶
- pyiced.every(duration, token)¶
Returns a
Subscriptionthat produces messages at a set interval.The first
Messageis produced after a duration, and then continues to produce more messages every duration after that.- Parameters
duration (Union[float, datetime.timedelta]) – The interval in seconds or as a duration. Must be at least 100 µs!
token (Object) – The first item of the message tuple to send to the
pyiced.IcedApp.update().
- Returns
The new subscription.
Every “duration” a message
(token, instant)is sent topyiced.IcedApp.update().See also
- Return type
See also
from asyncio import open_connection from contextlib import closing from pyiced import ( Align, Color, container, ContainerStyle, Font, IcedApp, Length, text, ) class AsyncMessageExample(IcedApp): def __init__(self): self.__font = None class settings: class window: size = (640, 320) def title(self): return 'Asynchronous Messages' def new(self): return [load_font()] def update(self, msg, clipboard): match msg: case ('Font', font): self.__font = font def view(self): return container( text('Hello, world!', size=80, font=self.__font), style=ContainerStyle( text_color=Color(0.95, 0.87, 0.22), background=Color(0.38, 0.60, 0.23), ), padding=20, align_x=Align.CENTER, align_y=Align.CENTER, width=Length.FILL, height=Length.FILL, ) async def load_font(): FONT_NAME = 'Yellowtail' FONT_HOST = 'fonts.cdnfonts.com' FONT_PATH = '/s/16054/Yellowtail-Regular.ttf' query = ( f"GET {FONT_PATH} HTTP/1.0\r\n" f"Host: {FONT_HOST}\r\n" f"Connection: closed\r\n" f"\r\n" ).encode('US-ASCII') reader, writer = await open_connection(FONT_HOST, 443, ssl=True) with closing(writer): writer.write(query) await writer.drain() while (await reader.readline()) != b'\r\n': continue data = await reader.read() await writer.wait_closed() return ('Font', Font(FONT_NAME, data)) if __name__ == '__main__': AsyncMessageExample().run()
- pyiced.stream()¶
TODO
from asyncio import sleep from pyiced import column, IcedApp, stream, text class StreamExample(IcedApp): def __init__(self): self.__stream = stream(self.__generator_func()) self.__index = 0 class settings: class window: size = (640, 40) def title(self): return 'Stream Example' def view(self): return column([text(f'Index: {self.__index / 10:.1f}')]) def subscriptions(self): if self.__stream is not None: return [self.__stream] def update(self, msg, clipboard): match msg: case 'done': self.__stream = None case int(index): self.__index = index async def __generator_func(self): for i in range(1, 101): yield i await sleep(0.1) yield 'done' if __name__ == '__main__': StreamExample().run()
- class pyiced.Subscription¶
TODO
from pyiced import ( Align, container, Message, IcedApp, Length, Subscription, text, ) class FullscreenExample(IcedApp): def __init__(self): self.__fullscreen = False self.__should_exit = False class settings: class window: size = (640, 320) def subscriptions(self): return [Subscription.UNCAPTURED] def fullscreen(self): return self.__fullscreen def should_exit(self): return self.__should_exit def title(self): return self.__message def update(self, msg, clipboard): match msg: case Message(keyboard='keyreleased', key_code='F11'): self.__fullscreen = not self.__fullscreen case Message(keyboard='keyreleased', key_code='Escape'): self.__should_exit = True def view(self): return container( text(self.__message, size=40), padding=20, align_x=Align.CENTER, align_y=Align.CENTER, width=Length.FILL, height=Length.FILL, ) @property def __message(self): if self.__fullscreen: return 'Fullscreen (press F11!)' else: return 'Windowed (press F11!)' if __name__ == '__main__': FullscreenExample().run()
- NONE = <pyiced.Subscription object>¶
- UNCAPTURED = <pyiced.Subscription object>¶