| | |
- alert(message)
- Display message in an error box. Return when the user closes the box.
- bug(message='A bug has been detected in this program. Please report the problem to the authors.')
- Display an error message and offer a debugging prompt.
- confirm(message, stock_icon, action=None)
- Display a <Cancel>/<Action> dialog. Result is true if the user
chooses the action, false otherwise. If action is given then that
is used as the text instead of the default for the stock item. Eg:
if rox.confirm('Really delete everything?', g.STOCK_DELETE): delete()
- croak(message)
- Display message in an error box, then quit the program, returning
with a non-zero exit status.
- edit_options(options_file=None)
- Edit the app_options (set using setup_app_options()) using the GUI
specified in 'options_file' (default <app_dir>/Options.xml).
If this function is called again while the box is still open, the
old box will be redisplayed to the user.
- escape(uri)
- Convert each space to %20, etc
- get_icon(path)
- Looks up an icon for the file named by path, in the order below, using the first
found:
1. The Filer's globicons file (not implemented)
2. A directory's .DirIcon file
3. A file in ~/.thumbnails whose name is the md5 hash of os.path.abspath(path), suffixed with '.png'
4. A file in $XDG_CONFIG_HOME/rox.sourceforge.net/MIME-Icons for the full type of the file.
5. An icon of the form 'gnome-mime-media-subtype' in the current GTK icon theme.
6. A file in $XDG_CONFIG_HOME/rox.sourceforge.net/MIME-Icons for the 'media' part of the file's type (eg, 'text')
7. An icon of the form 'gnome-mime-media' in the current icon theme.
Returns a gtk.gdk.Pixbuf instance for the chosen icon.
- get_local_path(uri)
- Convert 'uri' to a local path and return, if possible. If 'uri'
is a resource on a remote machine, return None. URI is in the escaped form
(%20 for space).
- info(message)
- Display informational message. Returns when the user closes the box.
- isappdir(path)
- Return True if the path refers to a valid ROX AppDir.
The tests are:
- path is a directory
- path is not world writable
- path contains an executable AppRun
- path/AppRun is not world writable
- path and path/AppRun are owned by the same user.
- mainloop()
- This is a wrapper around the gtk2.mainloop function. It only runs
the loop if there are top level references, and exits when
rox.toplevel_unref() reduces the count to zero.
- our_host_name()
- Try to return the canonical name for this computer. This is used
in the drag-and-drop protocol to work out whether a drop is coming from
a remote machine (and therefore has to be fetched differently).
- report_exception()
- Display the current python exception in an error box, returning
when the user closes the box. This is useful in the 'except' clause
of a 'try' block. Uses rox.debug.show_exception().
- setup_app_options(program, leaf='Options.xml', site=None)
- Most applications only have one set of options. This function can be
used to set up the default group. 'program' is the name of the
directory to use and 'leaf' is the name of the file used to store the
group. You can refer to the group using rox.app_options.
If site is given, the basedir module is used for saving options (the
new system). Otherwise, the deprecated choices module is used.
See rox.options.OptionGroup.
- toplevel_ref()
- Increment the toplevel ref count. rox.mainloop() won't exit until
toplevel_unref() is called the same number of times.
- toplevel_unref(*unused)
- Decrement the toplevel ref count. If this is called while in
rox.mainloop() and the count has reached zero, then rox.mainloop()
will exit. Ignores any arguments passed in, so you can use it
easily as a callback function.
- unescape(uri)
- Convert each %20 to a space, etc
|