org.kde.koala
Interface BrowserExtensionSignals


public interface BrowserExtensionSignals


Method Summary
 void addWebSideBar(KURL url, java.lang.String name)
          Ask the hosting application to add a new HTML (aka Mozilla/Netscape) SideBar entry.
 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,
 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,
 void enableAction(java.lang.String name, boolean enabled)
          Enables or disable a standard action held by the browser.
 void infoMessage(java.lang.String arg1)
           
 void loadingProgress(int percent)
          Since the part emits the jobid in the started() signal, progress information is automatically displayed.
 void mouseOverInfo(KFileItem item)
          Inform the hosting application that the user moved the mouse over an item.
 void moveTopLevelWidget(int x, int y)
          Ask the hosting application to move the top level widget.
 void openURLNotify()
          Tells the hosting browser that the part opened a new URL (which can be queried via KParts.Part.url().
 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.
 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.
 void openURLRequestDelayed(KURL url)
          This signal is emitted when openURLRequest is called, after a 0-seconds timer.
 void openURLRequestDelayed(KURL url, URLArgs args)
          This signal is emitted when openURLRequest is called, after a 0-seconds timer.
 void popupMenu(KXMLGUIClientInterface client, org.kde.qt.QPoint global, java.util.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
 void popupMenu(KXMLGUIClientInterface client, org.kde.qt.QPoint global, KURL url, java.lang.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
 void popupMenu(KXMLGUIClientInterface client, org.kde.qt.QPoint global, KURL url, java.lang.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
 void popupMenu(org.kde.qt.QPoint global, java.util.ArrayList items)
          Emit this to make the browser show a standard popup menu at the point global for the files items.
 void popupMenu(org.kde.qt.QPoint global, KURL url, java.lang.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...)
 void popupMenu(org.kde.qt.QPoint global, KURL url, java.lang.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...)
 void requestFocus(ReadOnlyPart part)
          Ask the hosting application to focus part.
 void resizeTopLevelWidget(int w, int h)
          Ask the hosting application to resize the top level widget.
 void selectionInfo(java.util.ArrayList items)
          Inform the hosting application about the current selection.
 void selectionInfo(java.lang.String text)
          Inform the hosting application about the current selection.
 void setActionText(java.lang.String name, java.lang.String text)
          Change the text of a standard action held by the browser.
 void setIconURL(KURL url)
          Sets the URL of an icon for the currently displayed page.
 void setLocationBarURL(java.lang.String url)
          Updates the URL shown in the browser's location bar to url.
 void setPageSecurity(int arg1)
          Tell the host (browser) about security state of current page enum PageSecurity { NotCrypted, Encrypted, Mixed }
 void speedProgress(int bytesPerSecond)
           
 

Method Detail

enableAction

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


setActionText

void setActionText(java.lang.String name,
                   java.lang.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.


openURLRequest

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.


openURLRequest

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.


openURLRequestDelayed

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.


openURLRequestDelayed

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.


openURLNotify

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.


setLocationBarURL

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


setIconURL

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


createNewWindow

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

createNewWindow

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

loadingProgress

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.


speedProgress

void speedProgress(int bytesPerSecond)
See Also:
loadingProgress(int)

infoMessage

void infoMessage(java.lang.String arg1)

popupMenu

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


popupMenu

void popupMenu(KXMLGUIClientInterface client,
               org.kde.qt.QPoint global,
               java.util.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


popupMenu

void popupMenu(org.kde.qt.QPoint global,
               KURL url,
               java.lang.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...)


popupMenu

void popupMenu(org.kde.qt.QPoint global,
               KURL url,
               java.lang.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...)


popupMenu

void popupMenu(KXMLGUIClientInterface client,
               org.kde.qt.QPoint global,
               KURL url,
               java.lang.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


popupMenu

void popupMenu(KXMLGUIClientInterface client,
               org.kde.qt.QPoint global,
               KURL url,
               java.lang.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


selectionInfo

void selectionInfo(java.util.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.)


selectionInfo

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


mouseOverInfo

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.


addWebSideBar

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


moveTopLevelWidget

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


resizeTopLevelWidget

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


requestFocus

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


setPageSecurity

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