campy.private.backends.backend_base module

Common abstract base classes for various backends.

There are three different types of backends.

• GraphicsBackendBase: Everything graphical - windows, canvas objects, labels, interactors.
• AudioBackendBase: Everything auditory - creating and playing sounds.
• ConsoleBackendBase: Everything textual - fonts and lines.

The Tk backend is a graphical backend only. The Java backend is all three.

Other implementations of ConsoleBackendBase have been spun out into their own library popup-console.

These abstract base classes are provided for backend developers to see which methods their backend will need to support. It is considered under development and can change at any time.

class campy.private.backends.backend_base.AudioBackendBase

Bases: abc.ABC

Interface for audio backends.

create_sound(sound, *args)

delete_sound(sound, *args)

play_note(note, repeat)

play_sound(sound, *args)

class campy.private.backends.backend_base.ConsoleBackendBase

Bases: abc.ABC

Interface for console backends.

clear_console()

echo_console()

end_line_console()

get_console_line()

put_console(line, stderr=False)

set_console_font(font)

set_console_size(console_size)

class campy.private.backends.backend_base.GraphicsBackendBase

Bases: abc.ABC

Interface for graphical backends.

event_add_keypress_handler(event, handler)

event_add_mouse_handler(event, handler)

event_add_window_changed_handler(handler)

event_generate_keypress(event)

event_generate_mouse(event)

event_pump_one()

event_set_window_closed_handler(handler)

g3drect_constructor(gobject, width, height, raised)

g3drect_set_raised(gobject, raised)

garc_constructor(garc)

garc_set_frame_rectangle(garc, x, y, width, height)

garc_set_start_angle(garc, angle)

garc_set_sweep_angle(garc, angle)

gbufferedimage_constructor(gobject, x, y, width, height)

gbufferedimage_fill(gobject, rgb)

gbufferedimage_fill_region(gobject, x, y, width, height, rgb)

gbufferedimage_load(gobject, filename)

gbufferedimage_resize(gobject, width, height, retain)

gbufferedimage_save(gobject, filename)

gbufferedimage_set_rgb(gobject, x, y, rgb)

gbufferedimage_update_all_pixels(gobject, base64)

gbutton_constructor(gbutton)

gbutton_set_disabled(gbutton)

gbutton_set_label(gbutton)

gcheckbox_constructor(gcheckbox)

gcheckbox_is_selected(gcheckbox)

gcheckbox_set_selected(gcheckbox, state)

gchooser_add_item(gchooser, item)

gchooser_constructor(gchooser)

gchooser_get_selected_item(gchooser)

gchooser_set_selected_item(gchooser, item)

gcompound_add(compound, gobject)

gcompound_constructor(gobject)

get_next_event(mask)

gfilechooser_show_open_dialog(current_dir, file_filter)

gfilechooser_show_save_dialog(current_dir, file_filter)

gfont_attributes_from_system_name(font_name)

gfont_default_attributes()

gfont_get_font_metrics(gfont)

gfont_measure_text_width(gfont, text)

gimage_blank(gimage, width, height)

gimage_constructor(gimage, filename)

gimage_get_pixel(gimage, row, col)

gimage_preview(gimage)

gimage_set_pixel(gimage, row, col, rgb)

glabel_constructor(glabel)

glabel_set_font(glabel, gfont)

glabel_set_label(glabel, text)

gline_constructor(gline)

gline_set_end_point(gline, x, y)

gline_set_start_point(gline, x, y)

gobject_contains(gobject, x, y)

gobject_get_bounds(gobject)

gobject_get_size(gobject)

gobject_remove(gobject)

gobject_rotate(gobject, theta)

gobject_scale(gobject, sx, sy)

gobject_send_backward(gobject)

gobject_send_forward(gobject)

gobject_send_to_back(gobject)

gobject_send_to_front(gobject)

gobject_set_color(gobject, color)

gobject_set_fill_color(gobject, color)

gobject_set_filled(gobject, flag)

gobject_set_line_width(gobject, line_width)

gobject_set_location(gobject, x, y)

gobject_set_size(gobject, width, height)

gobject_set_visible(gobject, flag)

goptionpane_show_confirm_dialog(message, title, confirm_type)

goptionpane_show_input_dialog(message, title)

goptionpane_show_message_dialog(message, title, message_type)

goptionpane_show_option_dialog(message, title, options, initially_selected)

goptionpane_show_text_file_dialog(message, title, rows, cols)

goval_constructor(goval)

gpolygon_add_vertex(gpolygon, x, y)

gpolygon_constructor(gpolygon)

grect_constructor(grect)

groundrect_constructor(gobject, width, height, corner)

gslider_constructor(gslider, min, max, value)

gslider_get_value(gslider)

gslider_set_value(gslider, value)

gtextfield_constructor(gtextfield, num_chars)

gtextfield_get_text(gtextfield)

gtextfield_set_text(gtextfield, text)

gtimer_constructor(timer)

gtimer_delete(timer)

gtimer_pause(timer, millis)

gtimer_start(timer)

gtimer_stop(timer)

gwindow_add_to_region(gwindow, gobject, region)

gwindow_clear(gwindow)

gwindow_clear_canvas(gwindow)

gwindow_close(gwindow)

gwindow_constructor(gwindow, width, height, top_compound, visible=True)

gwindow_delete(gwindow)

gwindow_draw(gwindow, gobject)

gwindow_exit_graphics()

gwindow_get_height()

gwindow_get_width()

gwindow_remove_from_region(gwindow, gobject, region)

gwindow_repaint(gwindow)

gwindow_request_focus(gwindow)

gwindow_set_exit_on_close(gwindow, exit_on_close)

gwindow_set_region_alignment(gwindow, region, align)

gwindow_set_visible(gwindow, flag)

gwindow_set_window_title(gwindow, title)

image_find(filename)

image_load(filename)

set_action_command(gobject, cmd)

timer_pause(event)

timer_schedule(function, delay_ms)

wait_for_event(mask)