org.kde.koala

Interface BrowserExtensionSignals

public interface BrowserExtensionSignals

Method Summary
voidaddWebSideBar(KURL url, String name)
Ask the hosting application to add a new HTML (aka Mozilla/Netscape) SideBar entry.
voidcreateNewWindow(KURL url, URLArgs args)
Asks the hosting browser to open a new window for the given url. The args argument is optional additional information for the browser,
voidcreateNewWindow(KURL url)
Asks the hosting browser to open a new window for the given url. The args argument is optional additional information for the browser,
voidenableAction(String name, boolean enabled)
Enables or disable a standard action held by the browser.
voidinfoMessage(String arg1)
voidloadingProgress(int percent)
Since the part emits the jobid in the started() signal, progress information is automatically displayed.
voidmouseOverInfo(KFileItem item)
Inform the hosting application that the user moved the mouse over an item.
voidmoveTopLevelWidget(int x, int y)
Ask the hosting application to move the top level widget.
voidopenURLNotify()
Tells the hosting browser that the part opened a new URL (which can be queried via KParts.Part.url().
voidopenURLRequest(KURL url, URLArgs args)
Asks the host (browser) to open url. To set a reload, the x and y offsets, the service type etc., fill in the appropriate fields in the args structure.
voidopenURLRequest(KURL url)
Asks the host (browser) to open url. To set a reload, the x and y offsets, the service type etc., fill in the appropriate fields in the args structure.
voidopenURLRequestDelayed(KURL url, URLArgs args)
This signal is emitted when openURLRequest is called, after a 0-seconds timer.
voidopenURLRequestDelayed(KURL url)
This signal is emitted when openURLRequest is called, after a 0-seconds timer.
voidpopupMenu(QPoint global, ArrayList items)
Emit this to make the browser show a standard popup menu at the point global for the files items.
voidpopupMenu(KXMLGUIClientInterface client, QPoint global, ArrayList items)
Emit this to make the browser show a standard popup menu at the point global for the files items. The GUI described by client is being merged with the popupmenu of the host
voidpopupMenu(QPoint global, KURL url, String mimeType, long mode)
Emit this to make the browser show a standard popup menu at the point global for the given url. Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...)
voidpopupMenu(QPoint global, KURL url, String mimeType)
Emit this to make the browser show a standard popup menu at the point global for the given url. Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...)
voidpopupMenu(KXMLGUIClientInterface client, QPoint global, KURL url, String mimeType, long mode)
Emit this to make the browser show a standard popup menu at the point global for the given url. Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...)
voidpopupMenu(KXMLGUIClientInterface client, QPoint global, KURL url, String mimeType)
Emit this to make the browser show a standard popup menu at the point global for the given url. Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...)
voidrequestFocus(ReadOnlyPart part)
Ask the hosting application to focus part.
voidresizeTopLevelWidget(int w, int h)
Ask the hosting application to resize the top level widget.
voidselectionInfo(ArrayList items)
Inform the hosting application about the current selection.
voidselectionInfo(String text)
Inform the hosting application about the current selection.
voidsetActionText(String name, String text)
Change the text of a standard action held by the browser.
voidsetIconURL(KURL url)
Sets the URL of an icon for the currently displayed page.
voidsetLocationBarURL(String url)
Updates the URL shown in the browser's location bar to url.
voidsetPageSecurity(int arg1)
Tell the host (browser) about security state of current page enum PageSecurity { NotCrypted, Encrypted, Mixed }
voidspeedProgress(int bytesPerSecond)

Method Detail

addWebSideBar

public void addWebSideBar(KURL url, String name)
Ask the hosting application to add a new HTML (aka Mozilla/Netscape) SideBar entry.

UNKNOWN: Ask the hosting application to add a new HTML (aka Mozilla/Netscape) SideBar entry.

createNewWindow

public void createNewWindow(KURL url, URLArgs args)
Asks the hosting browser to open a new window for the given url. The args argument is optional additional information for the browser,

See Also: URLArgs

UNKNOWN: Asks the hosting browser to open a new window for the given url.

createNewWindow

public void createNewWindow(KURL url)
Asks the hosting browser to open a new window for the given url. The args argument is optional additional information for the browser,

See Also: URLArgs

UNKNOWN: Asks the hosting browser to open a new window for the given url.

enableAction

public void enableAction(String name, boolean enabled)
Enables or disable a standard action held by the browser. See class documentation for the list of standard actions.

UNKNOWN: Enables or disable a standard action held by the browser.

infoMessage

public void infoMessage(String arg1)

loadingProgress

public void loadingProgress(int percent)
Since the part emits the jobid in the started() signal, progress information is automatically displayed. However, if you don't use a KIO.Job in the part, you can use loadingProgress() and speedProgress() to display progress information.

UNKNOWN: Since the part emits the jobid in the started() signal, progress information is automatically displayed.

mouseOverInfo

public void mouseOverInfo(KFileItem item)
Inform the hosting application that the user moved the mouse over an item. Used when the mouse is on an URL.

UNKNOWN: Inform the hosting application that the user moved the mouse over an item.

moveTopLevelWidget

public void moveTopLevelWidget(int x, int y)
Ask the hosting application to move the top level widget.

UNKNOWN: Ask the hosting application to move the top level widget.

openURLNotify

public void openURLNotify()
Tells the hosting browser that the part opened a new URL (which can be queried via KParts.Part.url(). This helps the browser to update/create an entry in the history. The part may not emit this signal together with openURLRequest(). Emit openURLRequest() if you want the browser to handle a URL the user asked to open (from within your part/document). This signal however is useful if you want to handle URLs all yourself internally, while still telling the hosting browser about new opened URLs, in order to provide a proper history functionality to the user. An example of usage is a html rendering component which wants to emit this signal when a child frame document changed its URL. Conclusion: you probably want to use openURLRequest() instead.

UNKNOWN: Tells the hosting browser that the part opened a new URL (which can be queried via KParts.Part.url().

openURLRequest

public void openURLRequest(KURL url, URLArgs args)
Asks the host (browser) to open url. To set a reload, the x and y offsets, the service type etc., fill in the appropriate fields in the args structure. Hosts should not connect to this signal but to openURLRequestDelayed.

UNKNOWN: Asks the host (browser) to open url.

openURLRequest

public void openURLRequest(KURL url)
Asks the host (browser) to open url. To set a reload, the x and y offsets, the service type etc., fill in the appropriate fields in the args structure. Hosts should not connect to this signal but to openURLRequestDelayed.

UNKNOWN: Asks the host (browser) to open url.

openURLRequestDelayed

public void openURLRequestDelayed(KURL url, URLArgs args)
This signal is emitted when openURLRequest is called, after a 0-seconds timer. This allows the caller to terminate what it's doing first, before (usually) being destroyed. Parts should never use this signal, hosts should only connect to this signal.

UNKNOWN: This signal is emitted when openURLRequest is called, after a 0-seconds timer.

openURLRequestDelayed

public void openURLRequestDelayed(KURL url)
This signal is emitted when openURLRequest is called, after a 0-seconds timer. This allows the caller to terminate what it's doing first, before (usually) being destroyed. Parts should never use this signal, hosts should only connect to this signal.

UNKNOWN: This signal is emitted when openURLRequest is called, after a 0-seconds timer.

popupMenu

public void popupMenu(QPoint global, ArrayList items)
Emit this to make the browser show a standard popup menu at the point global for the files items.

UNKNOWN: Emit this to make the browser show a standard popup menu at the point global for the files items.

popupMenu

public void popupMenu(KXMLGUIClientInterface client, QPoint global, ArrayList items)
Emit this to make the browser show a standard popup menu at the point global for the files items. The GUI described by client is being merged with the popupmenu of the host

UNKNOWN: Emit this to make the browser show a standard popup menu at the point global for the files items.

popupMenu

public void popupMenu(QPoint global, KURL url, String mimeType, long mode)
Emit this to make the browser show a standard popup menu at the point global for the given url. Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...)

UNKNOWN: Emit this to make the browser show a standard popup menu at the point global for the given url.

popupMenu

public void popupMenu(QPoint global, KURL url, String mimeType)
Emit this to make the browser show a standard popup menu at the point global for the given url. Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...)

UNKNOWN: Emit this to make the browser show a standard popup menu at the point global for the given url.

popupMenu

public void popupMenu(KXMLGUIClientInterface client, QPoint global, KURL url, String mimeType, long mode)
Emit this to make the browser show a standard popup menu at the point global for the given url. Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...) The GUI described by client is being merged with the popupmenu of the host

UNKNOWN: Emit this to make the browser show a standard popup menu at the point global for the given url.

popupMenu

public void popupMenu(KXMLGUIClientInterface client, QPoint global, KURL url, String mimeType)
Emit this to make the browser show a standard popup menu at the point global for the given url. Give as much information about this URL as possible, like the mimeType and the file type (mode: S_IFREG, S_IFDIR...) The GUI described by client is being merged with the popupmenu of the host

UNKNOWN: Emit this to make the browser show a standard popup menu at the point global for the given url.

requestFocus

public void requestFocus(ReadOnlyPart part)
Ask the hosting application to focus part.

UNKNOWN: Ask the hosting application to focus part.

resizeTopLevelWidget

public void resizeTopLevelWidget(int w, int h)
Ask the hosting application to resize the top level widget.

UNKNOWN: Ask the hosting application to resize the top level widget.

selectionInfo

public void selectionInfo(ArrayList items)
Inform the hosting application about the current selection. Used when a set of files/URLs is selected (with full information about those URLs, including size, permissions etc.)

UNKNOWN: Inform the hosting application about the current selection.

selectionInfo

public void selectionInfo(String text)
Inform the hosting application about the current selection. Used when some text is selected.

UNKNOWN: Inform the hosting application about the current selection.

setActionText

public void setActionText(String name, String text)
Change the text of a standard action held by the browser. This can be used to change "Paste" into "Paste Image" for instance. See class documentation for the list of standard actions.

UNKNOWN: Change the text of a standard action held by the browser.

setIconURL

public void setIconURL(KURL url)
Sets the URL of an icon for the currently displayed page.

UNKNOWN: Sets the URL of an icon for the currently displayed page.

setLocationBarURL

public void setLocationBarURL(String url)
Updates the URL shown in the browser's location bar to url.

UNKNOWN: Updates the URL shown in the browser's location bar to url.

setPageSecurity

public void setPageSecurity(int arg1)
Tell the host (browser) about security state of current page enum PageSecurity { NotCrypted, Encrypted, Mixed }

UNKNOWN: Tell the host (browser) about security state of current page enum PageSecurity { NotCrypted, Encrypted, Mixed }

speedProgress

public void speedProgress(int bytesPerSecond)

See Also: BrowserExtensionSignals

UNKNOWN: