l.s.w.i.ILinkData(Interface) : interface documentation

Part of lp.services.webapp.interfaces View In Hierarchy

Known subclasses: lp.services.webapp.interfaces.ILink

An object with immutable attributes that represents the data a programmer provides about a link in a menu.
Attribute target The place this link should link to. This may be a path relative to the context of the menu this link appears in, or an absolute path, or an absolute URL.
Attribute text The text of this link, as appears underlined on a page.
Attribute summary The summary text of this link, as appears as a tooltip on the link.
Attribute icon The name of the icon to use.
Attribute enabled Boolean to say whether this link is enabled.
Attribute site The name of the site this link is to, or None for the current site.
Attribute menu The INavigationMenu associated with the page this link points to.
Attribute sort_key The sort key to use when rendering it with a group of links.
Attribute hidden Boolean to say whether this link is hidden. This is separate from being enabled and is used to support links which need to be enabled but not viewable in the rendered HTML. The link may be changed to visible by JavaScript or some other means.
target =
The place this link should link to. This may be a path relative to the context of the menu this link appears in, or an absolute path, or an absolute URL.
text =
The text of this link, as appears underlined on a page.
summary =
The summary text of this link, as appears as a tooltip on the link.
icon =
The name of the icon to use.
enabled =
Boolean to say whether this link is enabled.
site =
The name of the site this link is to, or None for the current site.
menu =
The INavigationMenu associated with the page this link points to.
sort_key =
The sort key to use when rendering it with a group of links.
hidden =
Boolean to say whether this link is hidden. This is separate from being enabled and is used to support links which need to be enabled but not viewable in the rendered HTML. The link may be changed to visible by JavaScript or some other means.
API Documentation for Launchpad, generated by pydoctor at 2019-09-23 00:00:04.