GEPS 004: My Gramps and Gadgets

From Gramps
Revision as of 12:57, 29 December 2007 by Dsblank (talk | contribs) (Details)
Jump to: navigation, search

Proposed changes for enhancing GRAMPS by adding a new GUI API that allows data to be displayed on the screen, with graphical objects such as tables, buttons, text entry, links, etc. This would effectively be able to turn a user plugin into an interface for moving, say, the active person in the main window, or, possibly, for user-defined data entry.

Motivation

Allows users to add to the GRAMPS interface. A new page, currently called "My Gramps", would be created that allows for customized "gadgets" that perform various functions (other than tools and reports). This might include: interactive shells, TODO lists, logs, debugging tools, and various "folders" for organizing groups of people, families, or other objects.

Details

A prototype is now available for exploration and testing. To activate the prototype, add the following line to your .gramps/keys.ini file in the interface section:

data-views= MyGrampsView,PersonView,RelationshipView,FamilyListView,PedigreeView,EventView,SourceView,PlaceView,MediaView,RepositoryView,NoteView

This should be all on one line. You can change the order (and leave some pages out) as well with this key. (You can also add pages multiple times, but that isn't as useful as the active object on one page will change it on another).

On start up, the file gadgets.ini is looked for in the user's .gramps subdirectory. If it is not found, a set of gadgets are created, currently a Message Gadget with a welcome message and a Stats Gadget.

Mygramps.png

You can drag the Properties button (top left) of each gadget to move it around the screen. Clicking the Properties will (currently) detach the gadget from My Gramps and place it in its own window. The window will stay open regardless of page (relationship, pedigree, etc). Closing the detached view will put it back onto My Gramps. If you quit Gramps with a open gadget, when you start gramps again, it will open automatically.

Detached.png

You can add new gadgets by right clicking on an open space on My Gramps. You can also change the number of columns by right-clicking an open area on the My Gramps page.

There are currently 10 proof-of-concept gadgets:

  1. Family Gadget
  2. Event Gadget
  3. Top Surnames Gadget
  4. Stats Gadget
  5. Log Gadget
  6. Shell Gadget
  7. Python Gadget
  8. TODO Gadget
  9. Welcome Gadget

These are all defined in src/plugins/DefaultGadgets.py

The simplest gadget:

from DataViews import register

def init(gui):
    gui.set_text("Hello world!")

register(type="gadget",             # case in-senstitive keyword "gadget"
         name="Hello World Gadget", # gadget name, unique among gadgets
         height = 20,               # default size
         content = init,            # function/class; takes guigadget
         title="Sample Gadget",     # default title, user changeable
         )

Using the Gadget class, however, provides more functionality. It has a number of method possibilities:

  1. init- run once, on construction
  2. active_changed- run when active-changed is triggered
  3. db_changed- run when db-changed is triggered
  4. main- run once per db change, main process (a generator-must use yield at least once. yield True means true that there is more; yield False means all done)

There are methods for saving/loading data, and interacting with the gui. More details to come...

Discussion

This type of proposal is discussed on these threads:

http://www.nabble.com/A-ScreenDoc-idea-t847639.html

http://www.nabble.com/Re:-Interactive-Quick-Reports-(was-Notes-in-V3.0)-p12735768.html

http://www.nabble.com/QuickReports-and-TextBufDoc--tf4537797.html

http://www.nabble.com/Report-Interface-tf4559738.html

There is also a Feature Request to remind us:

http://bugs.gramps-project.org/view.php?id=1291