Last change
on this file since 14206 was 9665, checked in by stoecker, 8 years ago |
fix eol-style issues and similar formating stuff, see #12410
|
File size:
963 bytes
|
Line | |
---|
1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.gui.help;
|
---|
3 |
|
---|
4 | /**
|
---|
5 | * Help browser super interface.
|
---|
6 | * @since 9644
|
---|
7 | */
|
---|
8 | interface IHelpBrowser {
|
---|
9 |
|
---|
10 | /**
|
---|
11 | * Replies the current URL.
|
---|
12 | * @return the current URL
|
---|
13 | */
|
---|
14 | String getUrl();
|
---|
15 |
|
---|
16 | /**
|
---|
17 | * Replies the browser history.
|
---|
18 | * @return the browser history
|
---|
19 | */
|
---|
20 | HelpBrowserHistory getHistory();
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * Loads and displays the help information for a help topic given
|
---|
24 | * by a relative help topic name, i.e. "/Action/New".
|
---|
25 | *
|
---|
26 | * @param relativeHelpTopic the relative help topic
|
---|
27 | */
|
---|
28 | void openHelpTopic(String relativeHelpTopic);
|
---|
29 |
|
---|
30 | /**
|
---|
31 | * Opens an URL and displays the content.
|
---|
32 | *
|
---|
33 | * If the URL is the locator of an absolute help topic, help content is loaded from
|
---|
34 | * the JOSM wiki. Otherwise, the help browser loads the page from the given URL.
|
---|
35 | *
|
---|
36 | * @param url the url
|
---|
37 | */
|
---|
38 | void openUrl(String url);
|
---|
39 | }
|
---|
Note:
See
TracBrowser
for help on using the repository browser.