zim.gui.widgets.LinkEntry

class documentation

class LinkEntry(PageEntry, FileEntry): (source)

View In Hierarchy

Widget entering links in zim pages. This widget accepts either zim page paths, file paths and URLs.
Method __init__ Constructor
Method get_path No summary
Method update_input_valid Undocumented
Instance Variable action Undocumented
Instance Variable file_type_hint Undocumented

Inherited from PageEntry:

Method set_path Set the path to be shown in the entry. If you have the link as a string, use set_text() instead
Method set_use_relative_paths Set the notebook and path to be used for relative paths.
Method update_completion Undocumented
Instance Variable existing_only Undocumented
Instance Variable notebook Undocumented
Instance Variable notebookpath Undocumented
Instance Variable subpaths_only Undocumented
Method _fill_completion_any Undocumented
Method _fill_completion_for_anchor Undocumented
Class Variable _allow_select_root Undocumented

Inherited from InputEntry (via PageEntry):

Method clear Clear the text in the entry
Method do_input_valid_changed Undocumented
Method get_input_valid Get the valid state. @returns: True if the input is valid
Method get_text Get the text from the widget. Like Gtk.Entry.get_text() but with UTF-8 decoding and whitespace stripped. @returns: string
Method set_check_func Set a function to check whether input is valid or not @param check_func: the function
Method set_icon Add an icon in the entry widget behind the text
Method set_icon_to_clear Adds a "clear" icon in the entry widget
Method set_input_valid No summary
Constant ERROR_COLOR Undocumented
Class Variable __gsignals__ Undocumented
Instance Variable allow_empty Undocumented
Instance Variable allow_whitespace Undocumented
Instance Variable check_func Undocumented
Instance Variable show_empty_invalid Undocumented
Instance Variable _input_valid Undocumented
Instance Variable _normal_color Undocumented

Inherited from FSPathEntry (via FileEntry):

Method popup_dialog Run a dialog to browse for a file or folder. Used by the 'browse' button in input forms.
Method set_path Set the file path for this entry @param path: a File or Folder object
Method set_use_relative_paths Set the notebook and path to be used for relative paths.
Instance Variable notebook Undocumented
Instance Variable notebookpath Undocumented

Inherited from InputEntry (via FileEntry, FSPathEntry):

Method clear Clear the text in the entry
Method do_input_valid_changed Undocumented
Method get_input_valid Get the valid state. @returns: True if the input is valid
Method get_text Get the text from the widget. Like Gtk.Entry.get_text() but with UTF-8 decoding and whitespace stripped. @returns: string
Method set_check_func Set a function to check whether input is valid or not @param check_func: the function
Method set_icon Add an icon in the entry widget behind the text
Method set_icon_to_clear Adds a "clear" icon in the entry widget
Method set_input_valid No summary
Constant ERROR_COLOR Undocumented
Class Variable __gsignals__ Undocumented
Instance Variable allow_empty Undocumented
Instance Variable allow_whitespace Undocumented
Instance Variable check_func Undocumented
Instance Variable show_empty_invalid Undocumented
Instance Variable _input_valid Undocumented
Instance Variable _normal_color Undocumented
def __init__(self, notebook, path=None): (source)
overrides zim.gui.widgets.PageEntry.__init__
Constructor
Parameters
notebookthe Notebook object for resolving paths and completing existing pages, but allowed to be None e.g. for testing
patha Path object used for resolving relative links
def get_path(self): (source)
overrides zim.gui.widgets.PageEntry.get_path
Get the path shown in the widget. If None is returned the widget is flagged as invalid. So e.g. in a dialog you can get a path and refuse to close a dialog if the path is None and the user will automatically be alerted to the missing input.
Returns
a Path object or None is no valid path was entered
def update_input_valid(self): (source)
overrides zim.gui.widgets.PageEntry.update_input_valid

Undocumented

action = (source)
overrides zim.gui.widgets.FileEntry.action

Undocumented

file_type_hint = (source)
overrides zim.gui.widgets.FileEntry.file_type_hint

Undocumented