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

Module eagle
source code

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

Functions [hide private]
  _gen_ro_property(name, doc="")
Generates a Read-Only property.
  _callback_tuple(callback)
  _str_tuple(string)
  _obj_tuple(obj)
  _set_icon_list(gtkwidget, stock_id)
  information(message)
Show info message to user.
  info(message)
Show info message to user.
  warning(message)
Show warning message to user.
  warn(message)
Show warning message to user.
  error(message)
Show error message to user.
  err(message)
Show error message to user.
  yesno(message, yesdefault=False)
Show yes/no message to user.
  confirm(message, okdefault=False)
Show confirm message to user.
  run()
Enter the event loop
  quit()
Quit the event loop
  get_app_by_id(app_id)
Given an App unique identifier, return the reference to it.
  get_widget_by_id(widget_id, app_id=None)
Given an Widget 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.
  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.
  hide(widget_id, app_id=None)
Convenience function to get widget and call its hide() method.
  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.
  close(app_id=None)
Convenience function to get app and call its close() method.

Variables [hide private]
__author__  
__author_email__  
__license__  
__url__  
__version__  
__revision__  
__description__  
__long_description__  
__doc__  
required_gtk  
m  
_apps  

Function Details [hide private]

_gen_ro_property(name, doc="")

source code 

Generates a Read-Only property.

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

_callback_tuple(callback)

source code 

_str_tuple(string)

source code 

_obj_tuple(obj)

source code 

_set_icon_list(gtkwidget, stock_id)

source code 

information(message)

source code 
Show info message to user.

info(message)

source code 
Show info message to user.

warning(message)

source code 
Show warning message to user.

warn(message)

source code 
Show warning message to user.

error(message)

source code 
Show error message to user.

err(message)

source code 
Show error message to user.

yesno(message, yesdefault=False)

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

confirm(message, okdefault=False)

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

run()

source code 
Enter the event loop

quit()

source code 
Quit the event loop

get_app_by_id(app_id)

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

get_widget_by_id(widget_id, app_id=None)

source code 

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.

get_value(widget_id, app_id=None)

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

set_value(widget_id, value, app_id=None)

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

show(widget_id, app_id=None)

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

hide(widget_id, app_id=None)

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

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

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

set_inactive(widget_id, app_id=None)

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

close(app_id=None)

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

Variables Details [hide private]

__author__

Value:
'Gustavo Sverzut Barbieri'                                             
      

__author_email__

Value:
'barbieri@gmail.com'                                                   
      

__license__

Value:
'LGPL'                                                                 
      

__url__

Value:
'http://www.gustavobarbieri.com.br/eagle/'                             
      

__version__

Value:
'0.2'                                                                  
      

__revision__

Value:
'$Rev: 20 $'                                                           
      

__description__

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

__long_description__

Value:
'''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
...                                                                    
      

__doc__

Value:
'''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
...                                                                    
      

required_gtk

Value:
(2, 6, 0)                                                              
      

m

Value:
None                                                                  
      

_apps

Value:
{}