frame

class bgui.frame.Frame(parent, name, border=None, aspect=None, size=[1, 1], pos=[0, 0], sub_theme='', options=12)

Frame for storing other widgets

Parameters:
  • parent – the widget’s parent
  • name – the name of the widget
  • border – the size of the border around the frame (0 for no border)
  • aspect – constrain the widget size to a specified aspect ratio
  • size – a tuple containing the width and height
  • pos – a tuple containing the x and y position
  • sub_theme – name of a sub_theme defined in the theme file (similar to CSS classes)
  • options – various other options
add_animation(animation)

Add the animation to the list of currently running animations

Parameters:animation – The animation
border

The size of the border around the frame.

children

The widget’s children

colors

The colors for the four corners of the frame.

frozen

Whether or not the widget should accept events

move(position, time, callback=None)

Move a widget to a new position over a number of frames

Parameters:
  • positon – The new position
  • time – The time in milliseconds to take doing the move
  • callback – An optional callback that is called when he animation is complete
name

The widget’s name

on_active

The widget’s on_active callback

on_click

The widget’s on_click callback

on_hover

The widget’s on_hover callback

on_mouse_enter

The widget’s on_mouse_enter callback

on_mouse_exit

The widget’s on_mouse_exit callback

on_release

The widget’s on_release callback

parent

The widget’s parent

position

The widget’s position

size

The widget’s size

system

A reference to the system object

visible

Whether or not the widget is visible

z_index

The widget’s z-index. Widget’s with a higher z-index are drawn over those that have a lower z-index

Previous topic

Auto-Generated API Docs

Next topic

frame_button

This Page