Module eagle
[show private | hide private]
[frames | no frames]

Module eagle

Eagle is an abstraction layer atop Graphical Toolkits focused on making simple applications easy to build while powerful in features.

With Eagle you have many facilities to build application that needs just some buttons, user input and a canvas to draw.

Canvas is really simple, what makes Eagle a great solution to Computer Graphics and Image Processing software, the primary focus of this library.

User input widgets are persistent, you just need to mark them "persistent" or put them in the preferences area.

Eagle is not meant to be another Graphical Toolkit, you already have a bunch of them, like Qt, Gtk, wxWidgets (to name just a few). It's focused on applications that have few windows, with buttons, simple user input and canvas. Widgets are laid out automatically in 5 areas: left, right, top, bottom and center.

It provides useful widgets like: Color selector, Font selector, Quit button, Preferences button and bialog, About dialog and Help dialog.
Classes
AboutButton Push button to show AboutDialog of App.
App An application window.
Button A push button.
Canvas The drawing area.
CheckBox Check box.
CloseButton Push button to close App.
Color Button to select colors.
Entry Text entry.
Font Button to select fonts.
Group Group of various components.
HelpButton Push button to show HelpDialog of App.
HSeparator Horizontal separator
Image An image that can be loaded from files or binary data and saved to files.
IntSpin Integer-only Spin button.
Label Text label
OpenFileButton Push button to show dialog to choose an existing file.
Password Password entry.
PreferencesButton Push button to show PreferencesDialog of App.
Progress Progress bar.
QuitButton Push button to quit all Apps.
SaveFileButton Push button to show dialog to choose a file to save.
SelectFolderButton Push button to show dialog to choose an existing folder/directory.
Selection Selection box (aka Combo box).
Spin Spin button entry.
UIntSpin Unsigned integer-only Spin button.
VSeparator Horizontal separator
_EGDataWidget The base of every Eagle widget that holds data.
_EGObject The basic Eagle Object.
_EGWidget The base of every Graphical Component in Eagle.
_EGWidLabelEntry Widget that holds a label and an associated Entry.
_HPanel Internal widget to arrange components horizontally.
_Panel Internal widget to arrange components.
_Table Internal widget to arrange components in tabular form.
_VPanel Internal widget to arrange components vertically.
AboutDialog A window that displays information about the application.
AutoGenId Mix-In to auto-generate ids.
DebugDialog Dialog to show uncaught exceptions.
FileChooser A dialog to choose a file.
HelpDialog A window that displays application help.
PreferencesDialog A dialog to present user with preferences.

Function Summary
  close(app_id)
Convenience function to get app and call its close() method.
  confirm(message, okdefault)
Show confirm message to user.
  err(message)
Show error message to user.
  error(message)
Show error message to user.
  get_app_by_id(app_id)
Given an App unique identifier, return the reference to it.
  get_value(widget_id, app_id)
Convenience function to get widget and call its get_value() method.
  get_widget_by_id(widget_id, app_id)
Given an Widget unique identifier, return the reference to it.
  hide(widget_id, app_id)
Convenience function to get widget and call its hide() method.
  info(message)
Show info message to user.
  information(message)
Show info message to user.
  quit()
Quit the event loop
  run()
Enter the event loop
  set_active(widget_id, active, app_id)
Convenience function to get widget and call its set_active() method.
  set_inactive(widget_id, app_id)
Convenience function to get widget and call its set_inactive() method.
  set_value(widget_id, value, app_id)
Convenience function to get widget and call its set_value() method.
  show(widget_id, app_id)
Convenience function to get widget and call its show() method.
  warn(message)
Show warning message to user.
  warning(message)
Show warning message to user.
  yesno(message, yesdefault)
Show yes/no message to user.
  _callback_tuple(callback)
  _gen_ro_property(name, doc)
Generates a Read-Only property.
  _obj_tuple(obj)
  _set_icon_list(gtkwidget, stock_id)
  _str_tuple(string)

Function Details

close(app_id=None)

Convenience function to get app and call its close() method.

confirm(message, okdefault=False)

Show confirm message to user.
Parameters:
okdefault - if ok should be the default action.

err(message)

Show error message to user.

error(message)

Show error message to user.

get_app_by_id(app_id)

Given an App unique identifier, return the reference to it.

get_value(widget_id, app_id=None)

Convenience function to get widget and call its get_value() method.

get_widget_by_id(widget_id, app_id=None)

Given an Widget unique identifier, return the reference to it.

If app_id is not provided, will use the first App found.

Attention: Try to always provide app_id since it may lead to problems if your program have more than one App.

hide(widget_id, app_id=None)

Convenience function to get widget and call its hide() method.

info(message)

Show info message to user.

information(message)

Show info message to user.

quit()

Quit the event loop

run()

Enter the event loop

set_active(widget_id, active=True, app_id=None)

Convenience function to get widget and call its set_active() method.

set_inactive(widget_id, app_id=None)

Convenience function to get widget and call its set_inactive() method.

set_value(widget_id, value, app_id=None)

Convenience function to get widget and call its set_value() method.

show(widget_id, app_id=None)

Convenience function to get widget and call its show() method.

warn(message)

Show warning message to user.

warning(message)

Show warning message to user.

yesno(message, yesdefault=False)

Show yes/no message to user.
Parameters:
yesdefault - if yes should be the default action.

_gen_ro_property(name, doc='')

Generates a Read-Only property.

The generated property can be assigned only one value, if this value is not None, it cannot be changed.

Generated by Epydoc 2.1 on Sun Dec 25 16:27:53 2005 http://epydoc.sf.net