# Class k.u.h.HyperLink(PropertyObject, gtk.EventBox):

Part of kiwi.ui.hyperlink View In Hierarchy

No class docstring

Method | __init__ | Create a new hyperlink.
Method | get_text | Return the hyperlink text.
Method | set_text | Set the text of the hyperlink.
Method | set_menu | Set the menu to be used for popups.
Method | has_menu | Return whether the widget has a menu set.
Method | popup | Popup the menu and emit the popup signal.
Method | clicked | Fire a clicked signal.
Method | get_label | Get the internally stored widget.
Method | _update_look | Update the look of the hyperlink depending on state.
Method | _build_markup | Build a marked up string depending on parameters.
Method | _on_button_press_event | Called on mouse down.
Method | _on_button_release_event | Called on mouse up.
Method | _on_hover_changed | Called when the mouse pinter enters or leaves the widget.
Method | _on_notify | Called on property notification.
Method | _on_map_event | Called on initially mapping the widget.

Inherited from PropertyObject:

Class Method | __class_init__ | Undocumented
Method | __post_init__ | A hook which is called after the constructor is called.
Method | _set | Undocumented
Method | _get | Undocumented
Method | get_attribute_names | Undocumented
Method | is_default_value | Undocumented
Method | do_set_property | Undocumented
Method | do_get_property | Undocumented

def __init__(self, text=None, menu=None):
overrides kiwi.utils.PropertyObject.__init__
Create a new hyperlink.

Parameters | text | The text of the hyperlink. (type: str )

def get_text(self):
Return the hyperlink text.

def set_text(self, text):
Set the text of the hyperlink.

Parameters | text | The text to set the hyperlink to. (type: str )

def set_menu(self, menu):
Set the menu to be used for popups.

Parameters | menu | the gtk.Menu to be used. (type: gtk.Menu )

def has_menu(self):
Return whether the widget has a menu set.

Returns | a boolean value indicating whether the internal menu has been set.

def popup(self, menu=None, button=3, etime=0L):
Popup the menu and emit the popup signal.

Parameters | menu | The gtk.Menu to be popped up. This menu will be used instead of the internally set menu. If this parameter is not passed or None, the internal menu will be used. (type: gtk.Menu )
| button | An integer representing the button number pressed to cause the popup action. (type: int )
| etime | The time that the popup event was initiated. (type: long )

def clicked(self):
Fire a clicked signal.

def get_label(self):
Get the internally stored widget.

def _update_look(self):
Update the look of the hyperlink depending on state.

def _build_markup(self, text, color, underline, bold):
Build a marked up string depending on parameters.

def _on_button_press_event(self, eventbox, event):

Called on mouse down.

Behaves in 2 ways.

1. if left-button, register the start of a click and grab the mouse.

1. if right-button, emit a right-clicked signal +/- popup the menu.

def _on_button_release_event(self, eventbox, event):

Called on mouse up.

If the left-button is released and the widget was earlier activated by a mouse down event a clicked signal is fired.

def _on_hover_changed(self, eb, event, hover):
Called when the mouse pinter enters or leaves the widget.

Parameters | hover | Whether the mouse has entered the widget. (type: boolean )

def _on_notify(self, eventbox, param):

Called on property notification.

Ensure that the look is up to date with the properties

def _on_map_event(self, eventbox, event):

Called on initially mapping the widget.

Used here to set the cursor type.