#include <tdehtml_part.h>
Public Types | |
enum | GUIProfile { DefaultGUI , BrowserViewGUI } |
enum | CaretDisplayPolicy { CaretVisible , CaretInvisible , CaretBlink } |
enum | FindOptions { FindLinksOnly = 1 * KFindDialog::MinimumUserOption , FindNoPopups = 2 * KFindDialog::MinimumUserOption } |
enum | FormNotification { NoNotification = 0 , Before , Only , Unused =255 } |
Public Slots | |
void | setActiveNode (const DOM::Node &node) |
void | stopAnimations () |
TQCString | dcopObjectId () const |
TQVariant | executeScript (const TQString &script) |
void | setCaretMode (bool enable) |
void | setEditable (bool enable) |
void | setCaretVisible (bool show) |
void | submitFormProxy (const char *action, const TQString &url, const TQByteArray &formData, const TQString &target, const TQString &contentType=TQString::null, const TQString &boundary=TQString::null) |
Public Slots inherited from KParts::ReadOnlyPart |
Signals | |
void | onURL (const TQString &url) |
void | popupMenu (const TQString &url, const TQPoint &point) |
void | selectionChanged () |
void | nodeActivated (const DOM::Node &) |
void | docCreated () |
void | caretPositionChanged (const DOM::Node &node, long offset) |
void | formSubmitNotification (const char *action, const TQString &url, const TQByteArray &formData, const TQString &target, const TQString &contentType, const TQString &boundary) |
Signals inherited from KParts::ReadOnlyPart | |
void | started (TDEIO::Job *) |
void | completed () |
void | completed (bool pendingAction) |
void | canceled (const TQString &errMsg) |
Signals inherited from KParts::Part | |
void | setWindowCaption (const TQString &caption) |
void | setStatusBarText (const TQString &text) |
Public Member Functions | |
TDEHTMLPart (TQWidget *parentWidget=0, const char *widgetname=0, TQObject *parent=0, const char *name=0, GUIProfile prof=DefaultGUI) | |
TDEHTMLPart (TDEHTMLView *view, TQObject *parent=0, const char *name=0, GUIProfile prof=DefaultGUI) | |
virtual | ~TDEHTMLPart () |
virtual bool | openURL (const KURL &url) |
virtual bool | closeURL () |
virtual void | showError (TDEIO::Job *job) |
DOM::HTMLDocument | htmlDocument () const |
DOM::Document | document () const |
TQString | documentSource () const |
DOM::Node | activeNode () const |
KParts::BrowserExtension * | browserExtension () const |
KParts::LiveConnectExtension * | liveConnectExtension (const tdehtml::RenderPart *) const |
KParts::BrowserHostExtension * | browserHostExtension () const |
TDEHTMLView * | view () const |
void | setJScriptEnabled (bool enable) |
bool | jScriptEnabled () const |
KJS::Interpreter * | jScriptInterpreter () |
void | setStatusMessagesEnabled (bool enable) |
bool | statusMessagesEnabled () const |
void | setMetaRefreshEnabled (bool enable) |
bool | metaRefreshEnabled () const |
TQVariant | executeScript (const DOM::Node &n, const TQString &script) |
void | setDNDEnabled (bool b) |
bool | dndEnabled () const |
void | setJavaEnabled (bool enable) |
bool | javaEnabled () const |
KJavaAppletContext * | javaContext () |
KJavaAppletContext * | createJavaContext () |
void | setPluginsEnabled (bool enable) |
bool | pluginsEnabled () const |
void | setAutoloadImages (bool enable) |
bool | autoloadImages () const |
void | setOnlyLocalReferences (bool enable) |
bool | onlyLocalReferences () const |
bool | isCaretMode () const |
bool | isEditable () const |
void | setCaretPosition (DOM::Node node, long offset, bool extendSelection=false) |
CaretDisplayPolicy | caretDisplayPolicyNonFocused () const |
void | setCaretDisplayPolicyNonFocused (CaretDisplayPolicy policy) |
void | enableJScript (bool e) |
void | enableJava (bool e) |
void | enablePlugins (bool e) |
void | autoloadImages (bool e) |
void | enableMetaRefresh (bool e) |
bool | setCharset (const TQString &, bool) |
KURL | baseURL () const |
TQString | baseTarget () const |
KURL | backgroundURL () const |
void | scheduleRedirection (int delay, const TQString &url, bool lockHistory=true) |
virtual void | begin (const KURL &url=KURL(), int xOffset=0, int yOffset=0) |
virtual void | write (const char *str, int len=-1) |
virtual void | write (const TQString &str) |
virtual void | end () |
void | paint (TQPainter *, const TQRect &, int=0, bool *=0) |
bool | setEncoding (const TQString &name, bool override=false) |
TQString | encoding () const |
void | setUserStyleSheet (const KURL &url) |
void | setUserStyleSheet (const TQString &styleSheet) |
void | setStandardFont (const TQString &name) |
void | setFixedFont (const TQString &name) |
bool | gotoAnchor (const TQString &name) |
bool | nextAnchor () |
bool | prevAnchor () |
void | setURLCursor (const TQCursor &c) |
TQCursor | urlCursor () const |
void | findText () |
void | findText (const TQString &str, long options, TQWidget *parent=0, KFindDialog *findDialog=0) |
void | findTextBegin () |
bool | findTextNext (const TQString &str, bool forward, bool caseSensitive, bool isRegExp) |
bool | findTextNext () |
bool | findTextNext (bool reverse) |
void | setZoomFactor (int percent) |
int | zoomFactor () const |
virtual TQString | selectedText () const |
TQString | selectedTextAsHTML () const |
DOM::Range | selection () const |
void | selection (DOM::Node &startNode, long &startOffset, DOM::Node &endNode, long &endOffset) const |
void | setSelection (const DOM::Range &) |
bool | hasSelection () const |
void | selectAll () |
void | show () |
void | hide () |
KParts::PartManager * | partManager () |
virtual void | saveState (TQDataStream &stream) |
virtual void | restoreState (TQDataStream &stream) |
DOM::Node | nodeUnderMouse () const |
DOM::Node | nonSharedNodeUnderMouse () const |
const TDEHTMLSettings * | settings () const |
TDEHTMLPart * | parentPart () |
TQStringList | frameNames () const |
TQPtrList< KParts::ReadOnlyPart > | frames () const |
TDEHTMLPart * | findFrame (const TQString &f) |
TDEHTMLPart * | findFrameParent (KParts::ReadOnlyPart *callingPart, const TQString &f, tdehtml::ChildFrame **childFrame=0) |
KParts::ReadOnlyPart * | currentFrame () const |
bool | frameExists (const TQString &frameName) |
KJSProxy * | framejScript (KParts::ReadOnlyPart *framePart) |
KParts::ReadOnlyPart * | findFramePart (const TQString &f) |
void | setJSStatusBarText (const TQString &text) |
void | setJSDefaultStatusBarText (const TQString &text) |
TQString | jsStatusBarText () const |
TQString | jsDefaultStatusBarText () const |
TQString | referrer () const |
TQString | pageReferrer () const |
TQString | lastModified () const |
void | preloadStyleSheet (const TQString &url, const TQString &stylesheet) |
void | preloadScript (const TQString &url, const TQString &script) |
bool | restored () const |
void | setFormNotification (FormNotification fn) |
FormNotification | formNotification () const |
KURL | toplevelURL () |
bool | isModified () const |
void | setSuppressedPopupIndicator (bool enable) |
void | setSuppressedPopupIndicator (bool enable, TDEHTMLPart *originPart) |
bool | inProgress () const |
Public Member Functions inherited from KParts::ReadOnlyPart | |
ReadOnlyPart (TQObject *parent=0, const char *name=0) | |
void | setProgressInfoEnabled (bool show) |
bool | isProgressInfoEnabled () const |
KURL | url () const |
bool | openStream (const TQString &mimeType, const KURL &url) |
bool | writeStream (const TQByteArray &data) |
bool | closeStream () |
Public Member Functions inherited from KParts::Part | |
Part (TQObject *parent=0, const char *name=0) | |
virtual void | embed (TQWidget *parentWidget) |
virtual TQWidget * | widget () |
PartManager * | manager () const |
virtual Part * | hitTest (TQWidget *widget, const TQPoint &globalPos) |
virtual void | setSelectable (bool selectable) |
bool | isSelectable () const |
Public Member Functions inherited from KParts::PartBase | |
void | setPartObject (TQObject *object) |
Public Member Functions inherited from KXMLGUIClient | |
KXMLGUIClient (KXMLGUIClient *parent) | |
TDEAction * | action (const char *name) const |
virtual TDEAction * | action (const TQDomElement &element) const |
virtual TDEActionCollection * | actionCollection () const |
virtual TDEInstance * | instance () const |
virtual TQDomDocument | domDocument () const |
virtual TQString | xmlFile () const |
void | setXMLGUIBuildDocument (const TQDomDocument &doc) |
TQDomDocument | xmlguiBuildDocument () const |
void | setFactory (KXMLGUIFactory *factory) |
KXMLGUIFactory * | factory () const |
KXMLGUIClient * | parentClient () const |
void | insertChildClient (KXMLGUIClient *child) |
void | removeChildClient (KXMLGUIClient *child) |
const TQPtrList< KXMLGUIClient > * | childClients () |
void | setClientBuilder (KXMLGUIBuilder *builder) |
KXMLGUIBuilder * | clientBuilder () const |
void | reloadXML () |
void | plugActionList (const TQString &name, const TQPtrList< TDEAction > &actionList) |
void | unplugActionList (const TQString &name) |
void | beginXMLPlug (TQWidget *) |
void | endXMLPlug () |
void | prepareXMLUnplug (TQWidget *) |
Protected Types | |
enum | PageSecurity { NotCrypted , Encrypted , Mixed } |
Protected Types inherited from KParts::PartBase | |
enum | PluginLoadingMode |
Protected Member Functions | |
KURL | completeURL (const TQString &url) |
void | htmlError (int errorCode, const TQString &text, const KURL &reqUrl) |
virtual void | customEvent (TQCustomEvent *event) |
virtual void | tdehtmlMousePressEvent (tdehtml::MousePressEvent *event) |
virtual void | tdehtmlMouseDoubleClickEvent (tdehtml::MouseDoubleClickEvent *) |
virtual void | tdehtmlMouseMoveEvent (tdehtml::MouseMoveEvent *event) |
virtual void | tdehtmlMouseReleaseEvent (tdehtml::MouseReleaseEvent *event) |
virtual void | tdehtmlDrawContentsEvent (tdehtml::DrawContentsEvent *) |
virtual void | guiActivateEvent (KParts::GUIActivateEvent *event) |
virtual bool | openFile () |
virtual void | urlSelected (const TQString &url, int button, int state, const TQString &_target, KParts::URLArgs args=KParts::URLArgs()) |
virtual KParts::ReadOnlyPart * | createPart (TQWidget *parentWidget, const char *widgetName, TQObject *parent, const char *name, const TQString &mimetype, TQString &serviceName, TQStringList &serviceTypes, const TQStringList ¶ms) |
bool | pluginPageQuestionAsked (const TQString &mimetype) const |
void | setPluginPageQuestionAsked (const TQString &mimetype) |
void | setPageSecurity (PageSecurity sec) |
virtual bool | doOpenStream (const TQString &mimeType) |
virtual bool | doWriteStream (const TQByteArray &data) |
virtual bool | doCloseStream () |
Protected Member Functions inherited from KParts::Part | |
virtual void | setWidget (TQWidget *widget) |
virtual void | partActivateEvent (PartActivateEvent *event) |
virtual void | partSelectEvent (PartSelectEvent *event) |
TQWidget * | hostContainer (const TQString &containerName) |
Protected Member Functions inherited from KParts::PartBase | |
virtual void | setInstance (TDEInstance *instance) |
virtual void | setInstance (TDEInstance *instance, bool loadPlugins) |
void | loadPlugins (TQObject *parent, KXMLGUIClient *parentGUIClient, TDEInstance *instance) |
void | setPluginLoadingMode (PluginLoadingMode loadingMode) |
Protected Member Functions inherited from KXMLGUIClient | |
virtual void | setXMLFile (const TQString &file, bool merge=false, bool setXMLDoc=true) |
virtual void | setXML (const TQString &document, bool merge=false) |
virtual void | setDOMDocument (const TQDomDocument &document, bool merge=false) |
virtual void | conserveMemory () |
virtual void | stateChanged (const TQString &newstate, ReverseStateChange reverse=StateNoReverse) |
Additional Inherited Members | |
Protected Attributes inherited from KParts::ReadOnlyPart | |
KURL | m_url |
TQString | m_file |
bool | m_bTemp |
Protected Attributes inherited from KParts::PartBase | |
DoNotLoadPlugins | |
LoadPlugins | |
LoadPluginsIfEnabled | |
Detailed Description
This class is tdehtml's main class.
It features an almost complete web browser, and html renderer.
The easiest way to use this class (if you just want to display an HTML page at some URL) is the following:
Java and JavaScript are enabled by default depending on the user's settings. If you do not need them, and especially if you display unfiltered data from untrusted sources, it is strongly recommended to turn them off. In that case, you should also turn off the automatic redirect and plugins:
You may also wish to disable external references. This will prevent TDEHTML from loading images, frames, etc, or redirecting to external sites.
Some apps want to write their HTML code directly into the widget instead of opening an url. You can do this in the following way:
You can do as many calls to write() as you wish. There are two write() methods, one accepting a TQString and one accepting a char
*
argument. You should use one or the other (but not both) since the method using the char
*
argument does an additional decoding step to convert the written data to Unicode.
It is also possible to write content to the HTML part using the standard streaming API from KParts::ReadOnlyPart. The usage of the API is similar to that of the begin(), write(), end() process described above as the following example shows:
HTML Browser Widget
Definition at line 183 of file tdehtml_part.h.
Member Enumeration Documentation
◆ CaretDisplayPolicy
Enumeration for displaying the caret.
- Parameters
-
Visible caret is displayed Invisible caret is not displayed Blink caret toggles between visible and invisible
- Since
- 3.2
Definition at line 495 of file tdehtml_part.h.
◆ FindOptions
Extra Find options that can be used when calling the extended findText().
- Since
- 3.3
Definition at line 702 of file tdehtml_part.h.
Constructor & Destructor Documentation
◆ TDEHTMLPart()
TDEHTMLPart::TDEHTMLPart | ( | TQWidget * | parentWidget = 0 , |
const char * | widgetname = 0 , |
||
TQObject * | parent = 0 , |
||
const char * | name = 0 , |
||
GUIProfile | prof = DefaultGUI |
||
) |
Constructs a new TDEHTMLPart.
TDEHTML basically consists of two objects: The TDEHTMLPart itself, holding the document data (DOM document), and the TDEHTMLView, derived from TQScrollView, in which the document content is rendered in. You can specify two different parent objects for a TDEHTMLPart, one parent for the TDEHTMLPart document and on parent for the TDEHTMLView. If the second parent
argument is 0L, then parentWidget
is used as parent for both objects, the part and the view.
Definition at line 205 of file tdehtml_part.cpp.
◆ ~TDEHTMLPart()
|
virtual |
Destructor.
Definition at line 467 of file tdehtml_part.cpp.
Member Function Documentation
◆ activeNode()
DOM::Node TDEHTMLPart::activeNode | ( | ) | const |
Returns the node that has the keyboard focus.
Definition at line 6938 of file tdehtml_part.cpp.
◆ autoloadImages()
bool TDEHTMLPart::autoloadImages | ( | ) | const |
Returns whether images contained in the document are loaded automatically or not.
- Note
- that the returned information is unrelieable as long as no begin() was called.
Definition at line 1359 of file tdehtml_part.cpp.
◆ backgroundURL()
KURL TDEHTMLPart::backgroundURL | ( | ) | const |
Returns the URL for the background Image (used by save background)
Definition at line 4117 of file tdehtml_part.cpp.
◆ begin()
Clears the widget and prepares it for new content.
If you want url() to return for example "file:/tmp/test.html", you can use the following code:
- Parameters
-
url is the url of the document to be displayed. Even if you are generating the HTML on the fly, it may be useful to specify a directory so that any pixmaps are found. xOffset is the initial horizontal scrollbar value. Usually you don't want to use this. yOffset is the initial vertical scrollbar value. Usually you don't want to use this.
All child frames and the old document are removed if you call this method.
Definition at line 1875 of file tdehtml_part.cpp.
◆ browserExtension()
KParts::BrowserExtension * TDEHTMLPart::browserExtension | ( | ) | const |
Returns a pointer to the KParts::BrowserExtension.
Definition at line 896 of file tdehtml_part.cpp.
◆ caretDisplayPolicyNonFocused()
TDEHTMLPart::CaretDisplayPolicy TDEHTMLPart::caretDisplayPolicyNonFocused | ( | ) | const |
Returns the current caret policy when the view is not focused.
- Since
- 3.2
Definition at line 2702 of file tdehtml_part.cpp.
◆ caretPositionChanged
|
signal |
This signal is emitted whenever the caret position has been changed.
The signal transmits the position the DOM::Range way, the node and the zero-based offset within this node.
- Parameters
-
node node which the caret is in. This can be null if the caret has been deactivated. offset offset within the node. If the node is null, the offset is meaningless.
- Since
- 3.2
◆ closeURL()
|
virtual |
Stops loading the document and kills all data requests (for images, etc.)
Reimplemented from KParts::ReadOnlyPart.
Definition at line 769 of file tdehtml_part.cpp.
◆ completeURL()
|
protected |
returns a KURL object for the given url.
Use when you know what you're doing.
Definition at line 2371 of file tdehtml_part.cpp.
◆ createJavaContext()
KJavaAppletContext * TDEHTMLPart::createJavaContext | ( | ) |
Returns the java context of the applets.
If no context exists yet, a new one is created.
Definition at line 1268 of file tdehtml_part.cpp.
◆ createPart()
|
protectedvirtual |
This method is called when a new embedded object (include html frames) is to be created.
Reimplement it if you want to add support for certain embeddable objects without registering them in the KDE wide registry system (KSyCoCa) . Another reason for re-implementing this method could be if you want to derive from KTHMLPart and also want all html frame objects to be a object of your derived type, in which case you should return a new instance for the mimetype 'text/html' .
Definition at line 4649 of file tdehtml_part.cpp.
◆ currentFrame()
KParts::ReadOnlyPart * TDEHTMLPart::currentFrame | ( | ) | const |
Return the current frame (the one that has focus) Not necessarily a direct child of ours, framesets can be nested.
Returns "this" if this part isn't a frameset.
Definition at line 5276 of file tdehtml_part.cpp.
◆ dndEnabled()
bool TDEHTMLPart::dndEnabled | ( | ) | const |
Returns whether Dragn'n'Drop support is enabled or not.
Definition at line 5939 of file tdehtml_part.cpp.
◆ doCloseStream()
|
protectedvirtual |
Implements the streaming API of KParts::ReadOnlyPart.
Definition at line 2042 of file tdehtml_part.cpp.
◆ document()
DOM::Document TDEHTMLPart::document | ( | ) | const |
Returns a reference to the DOM document.
Definition at line 859 of file tdehtml_part.cpp.
◆ documentSource()
TQString TDEHTMLPart::documentSource | ( | ) | const |
Returns the content of the source document.
- Since
- 3.4
Definition at line 864 of file tdehtml_part.cpp.
◆ doOpenStream()
|
protectedvirtual |
Implements the streaming API of KParts::ReadOnlyPart.
Definition at line 2025 of file tdehtml_part.cpp.
◆ doWriteStream()
|
protectedvirtual |
Implements the streaming API of KParts::ReadOnlyPart.
Definition at line 2036 of file tdehtml_part.cpp.
◆ encoding()
TQString TDEHTMLPart::encoding | ( | ) | const |
Returns the encoding the page currently uses.
Note that the encoding might be different from the charset.
Definition at line 2485 of file tdehtml_part.cpp.
◆ end()
|
virtual |
Call this after your last call to write().
Definition at line 2010 of file tdehtml_part.cpp.
◆ executeScript() [1/2]
TQVariant TDEHTMLPart::executeScript | ( | const DOM::Node & | n, |
const TQString & | script | ||
) |
Same as executeScript( const TQString & ) except with the Node parameter specifying the 'this' value.
Definition at line 1186 of file tdehtml_part.cpp.
◆ executeScript [2/2]
|
slot |
Execute the specified snippet of JavaScript code.
Returns true
if JavaScript was enabled, no error occurred and the code returned true itself or false
otherwise.
- Deprecated:
- , use executeString( DOM::Node(), script)
Definition at line 1181 of file tdehtml_part.cpp.
◆ findFrame()
TDEHTMLPart * TDEHTMLPart::findFrame | ( | const TQString & | f | ) |
Finds a frame by name.
Returns 0L if frame can't be found.
Definition at line 5257 of file tdehtml_part.cpp.
◆ findFrameParent()
TDEHTMLPart * TDEHTMLPart::findFrameParent | ( | KParts::ReadOnlyPart * | callingPart, |
const TQString & | f, | ||
tdehtml::ChildFrame ** | childFrame = 0 |
||
) |
Recursively finds the part containing the frame with name f
and checks if it is accessible by callingPart
Returns 0L if no suitable frame can't be found.
Returns parent part if a suitable frame was found and frame info in *childFrame
- Since
- 3.3
Definition at line 5215 of file tdehtml_part.cpp.
◆ findFramePart()
KParts::ReadOnlyPart * TDEHTMLPart::findFramePart | ( | const TQString & | f | ) |
Finds a frame by name.
Returns 0L if frame can't be found.
Definition at line 5270 of file tdehtml_part.cpp.
◆ findText() [1/2]
void TDEHTMLPart::findText | ( | ) |
Starts a new search by popping up a dialog asking the user what he wants to search for.
- Since
- 3.3
Definition at line 2996 of file tdehtml_part.cpp.
◆ findText() [2/2]
void TDEHTMLPart::findText | ( | const TQString & | str, |
long | options, | ||
TQWidget * | parent = 0 , |
||
KFindDialog * | findDialog = 0 |
||
) |
Starts a new search, but bypasses the user dialog.
- Parameters
-
str The string to search for. options Find options. parent Parent used for centering popups like "string not found". findDialog Optionally, you can supply your own dialog.
- Since
- 3.3
Definition at line 3035 of file tdehtml_part.cpp.
◆ findTextBegin()
void TDEHTMLPart::findTextBegin | ( | ) |
Initiates a text search.
Definition at line 2737 of file tdehtml_part.cpp.
◆ findTextNext() [1/3]
bool TDEHTMLPart::findTextNext | ( | ) |
Finds the next occurence of a string set by findText()
- Returns
- true if a new match was found.
- Since
- 3.3
Definition at line 3063 of file tdehtml_part.cpp.
◆ findTextNext() [2/3]
bool TDEHTMLPart::findTextNext | ( | bool | reverse | ) |
Finds the next occurence of a string set by findText()
- Parameters
-
reverse if true, revert seach direction (only if no find dialog is used)
- Returns
- true if a new match was found.
- Since
- 3.5
Definition at line 3069 of file tdehtml_part.cpp.
◆ findTextNext() [3/3]
bool TDEHTMLPart::findTextNext | ( | const TQString & | str, |
bool | forward, | ||
bool | caseSensitive, | ||
bool | isRegExp | ||
) |
Finds the next occurrence of the string or expression.
If isRegExp is true then str is converted to a TQRegExp, and caseSensitive is ignored.
- Deprecated:
- , use findText( str, options, parent, findDialog )
Definition at line 2823 of file tdehtml_part.cpp.
◆ formNotification()
TDEHTMLPart::FormNotification TDEHTMLPart::formNotification | ( | ) | const |
Determine if signal should be emitted before, instead or never when a submitForm() happens.
KDE4 remove me
- Since
- 3.2
Definition at line 7334 of file tdehtml_part.cpp.
◆ formSubmitNotification
|
signal |
◆ frameExists()
bool TDEHTMLPart::frameExists | ( | const TQString & | frameName | ) |
Returns whether a frame with the specified name is exists or not.
In contrary to the findFrame method this one also returns true if the frame is defined but no displaying component has been found/loaded, yet.
Definition at line 5291 of file tdehtml_part.cpp.
◆ framejScript()
KJSProxy * TDEHTMLPart::framejScript | ( | KParts::ReadOnlyPart * | framePart | ) |
Returns child frame framePart its script interpreter.
Definition at line 5303 of file tdehtml_part.cpp.
◆ frameNames()
TQStringList TDEHTMLPart::frameNames | ( | ) | const |
Returns a list of names of all frame (including iframe) objects of the current document.
Note that this method is not working recursively for sub-frames.
Definition at line 5891 of file tdehtml_part.cpp.
◆ gotoAnchor()
bool TDEHTMLPart::gotoAnchor | ( | const TQString & | name | ) |
Finds the anchor named name
.
If the anchor is found, the widget scrolls to the closest position. Returns if
the anchor has been found.
Definition at line 2521 of file tdehtml_part.cpp.
◆ guiActivateEvent()
|
protectedvirtual |
Internal reimplementation of KParts::Part::guiActivateEvent .
Reimplemented from KParts::ReadOnlyPart.
Definition at line 6636 of file tdehtml_part.cpp.
◆ hasSelection()
bool TDEHTMLPart::hasSelection | ( | ) | const |
Has the user selected anything?
Call selectedText() to retrieve the selected text.
- Returns
true
if there is text selected.
Definition at line 3596 of file tdehtml_part.cpp.
◆ hide()
void TDEHTMLPart::hide | ( | ) |
◆ htmlDocument()
DOM::HTMLDocument TDEHTMLPart::htmlDocument | ( | ) | const |
Returns a reference to the DOM HTML document (for non-HTML documents, returns null)
Definition at line 851 of file tdehtml_part.cpp.
◆ htmlError()
|
protected |
presents a detailed error message to the user.
errorCode
tdeio error code, eg TDEIO::ERR_SERVER_TIMEOUT. text
tdeio additional information text. url
the url that triggered the error.
Definition at line 1719 of file tdehtml_part.cpp.
◆ isCaretMode()
bool TDEHTMLPart::isCaretMode | ( | ) | const |
◆ isEditable()
bool TDEHTMLPart::isEditable | ( | ) | const |
Returns true
if the document is editable, false
otherwise.
- Since
- 3.2
Definition at line 2683 of file tdehtml_part.cpp.
◆ isModified()
bool TDEHTMLPart::isModified | ( | ) | const |
Checks whether the page contains unsubmitted form changes.
- Returns
- true if form changes exist
- Since
- 3.3
Definition at line 7350 of file tdehtml_part.cpp.
◆ javaContext()
KJavaAppletContext * TDEHTMLPart::javaContext | ( | ) |
Returns the java context of the applets.
If no applet exists, 0 is returned.
Definition at line 1263 of file tdehtml_part.cpp.
◆ javaEnabled()
bool TDEHTMLPart::javaEnabled | ( | ) | const |
Return true if Java applet support is enabled, false if disabled.
Definition at line 1250 of file tdehtml_part.cpp.
◆ jScriptEnabled()
bool TDEHTMLPart::jScriptEnabled | ( | ) | const |
Returns true
if Javascript support is enabled or false
otherwise.
Definition at line 939 of file tdehtml_part.cpp.
◆ jScriptInterpreter()
KJS::Interpreter * TDEHTMLPart::jScriptInterpreter | ( | ) |
Returns the JavaScript interpreter the part is using.
This method is mainly intended for applications which embed and extend the part and provides a mechanism for adding additional native objects to the interpreter (or removing the built-ins).
One thing people using this method to add things to the interpreter must consider, is that when you start writing new content to the part, the interpreter is cleared. This includes both use of the begin( const KURL &, int, int ) method, and the openURL( const KURL & ) method. If you want your objects to have a longer lifespan, then you must retain a KJS::Object yourself to ensure that the reference count of your custom objects never reaches 0. You will also need to re-add your bindings everytime this happens - one way to detect the need for this is to connect to the docCreated() signal, another is to reimplement the begin() method.
Definition at line 916 of file tdehtml_part.cpp.
◆ jsDefaultStatusBarText()
TQString TDEHTMLPart::jsDefaultStatusBarText | ( | ) | const |
Called by KJS.
Returns the DefaultStatusBarText assigned via window.defaultStatus
Definition at line 5804 of file tdehtml_part.cpp.
◆ jsStatusBarText()
TQString TDEHTMLPart::jsStatusBarText | ( | ) | const |
Called by KJS.
Returns the StatusBarText assigned via window.status
Definition at line 5799 of file tdehtml_part.cpp.
◆ lastModified()
TQString TDEHTMLPart::lastModified | ( | ) | const |
Last-modified date (in raw string format), if received in the [HTTP] headers.
Definition at line 5835 of file tdehtml_part.cpp.
◆ metaRefreshEnabled()
bool TDEHTMLPart::metaRefreshEnabled | ( | ) | const |
Returns true
if automatic forwarding is enabled.
Definition at line 953 of file tdehtml_part.cpp.
◆ nextAnchor()
bool TDEHTMLPart::nextAnchor | ( | ) |
Go to the next anchor.
This is useful to navigate from outside the navigator
- Since
- 3.2
Definition at line 2569 of file tdehtml_part.cpp.
◆ nodeActivated
|
signal |
This signal is emitted when an element retrieves the keyboard focus.
Note that the signal argument can be a null node if no element is active, meaning a node has explicitly been deactivated without a new one becoming active.
◆ nodeUnderMouse()
DOM::Node TDEHTMLPart::nodeUnderMouse | ( | ) | const |
Returns the Node
currently under the mouse.
The returned node may be a shared node (e. g. an <area> node if the mouse is hovering over an image map).
Definition at line 5644 of file tdehtml_part.cpp.
◆ nonSharedNodeUnderMouse()
DOM::Node TDEHTMLPart::nonSharedNodeUnderMouse | ( | ) | const |
Returns the Node
currently under the mouse that is not shared.
The returned node is always the node that is physically under the mouse pointer (irrespective of logically overlying elements like, e. g., <area> on image maps).
- Since
- 3.3
Definition at line 5649 of file tdehtml_part.cpp.
◆ onlyLocalReferences()
bool TDEHTMLPart::onlyLocalReferences | ( | ) | const |
Returns whether only file:/ or data:/ references are allowed to be loaded ( default false ).
See setOnlyLocalReferences.
Definition at line 2607 of file tdehtml_part.cpp.
◆ onURL
|
signal |
Emitted if the cursor is moved over an URL.
◆ openFile()
|
protectedvirtual |
Internal empty reimplementation of KParts::ReadOnlyPart::openFile .
Implements KParts::ReadOnlyPart.
Definition at line 1498 of file tdehtml_part.cpp.
◆ openURL()
|
virtual |
Opens the specified URL url
.
Reimplemented from KParts::ReadOnlyPart::openURL .
The format of the error url is that two variables are passed in the query: error = int tdeio error code, errText = TQString error text from tdeio and the URL where the error happened is passed as a sub URL.
Reimplemented from KParts::ReadOnlyPart.
Definition at line 565 of file tdehtml_part.cpp.
◆ pageReferrer()
TQString TDEHTMLPart::pageReferrer | ( | ) | const |
Referrer used to obtain this page.
Definition at line 5814 of file tdehtml_part.cpp.
◆ paint()
void TDEHTMLPart::paint | ( | TQPainter * | p, |
const TQRect & | rc, | ||
int | yOff = 0 , |
||
bool * | more = 0 |
||
) |
Paints the HTML page to a TQPainter.
See TDEHTMLView::paint for details
Definition at line 2049 of file tdehtml_part.cpp.
◆ parentPart()
TDEHTMLPart * TDEHTMLPart::parentPart | ( | ) |
Returns a pointer to the parent TDEHTMLPart if the part is a frame in an HTML frameset.
Returns 0L otherwise.
Definition at line 5321 of file tdehtml_part.cpp.
◆ partManager()
KParts::PartManager * TDEHTMLPart::partManager | ( | ) |
Returns a reference to the partmanager instance which manages html frame objects.
Definition at line 4703 of file tdehtml_part.cpp.
◆ pluginsEnabled()
bool TDEHTMLPart::pluginsEnabled | ( | ) | const |
Returns true if plugins are enabled/disabled.
Definition at line 1279 of file tdehtml_part.cpp.
◆ popupMenu
|
signal |
Emitted when the user clicks the right mouse button on the document.
◆ preloadScript()
void TDEHTMLPart::preloadScript | ( | const TQString & | url, |
const TQString & | script | ||
) |
Loads a script into the script cache.
Definition at line 6978 of file tdehtml_part.cpp.
◆ preloadStyleSheet()
void TDEHTMLPart::preloadStyleSheet | ( | const TQString & | url, |
const TQString & | stylesheet | ||
) |
Loads a style sheet into the stylesheet cache.
Definition at line 6973 of file tdehtml_part.cpp.
◆ prevAnchor()
bool TDEHTMLPart::prevAnchor | ( | ) |
◆ referrer()
TQString TDEHTMLPart::referrer | ( | ) | const |
Referrer used for links in this page.
Definition at line 5809 of file tdehtml_part.cpp.
◆ restoreState()
|
virtual |
Restores the TDEHTMLPart's previously saved state (including child frame objects) from the provided TQDataStream.
- See also
- saveState()
This is called from the restoreState() method of the browserExtension() .
Definition at line 5444 of file tdehtml_part.cpp.
◆ saveState()
|
virtual |
Saves the TDEHTMLPart's complete state (including child frame objects) to the provided TQDataStream.
This is called from the saveState() method of the browserExtension().
Definition at line 5358 of file tdehtml_part.cpp.
◆ scheduleRedirection()
void TDEHTMLPart::scheduleRedirection | ( | int | delay, |
const TQString & | url, | ||
bool | lockHistory = true |
||
) |
Schedules a redirection after delay
seconds.
Definition at line 2383 of file tdehtml_part.cpp.
◆ selectAll()
void TDEHTMLPart::selectAll | ( | ) |
Marks all text in the document as selected.
Definition at line 6749 of file tdehtml_part.cpp.
◆ selectedText()
|
virtual |
Returns the text the user has marked.
Definition at line 3454 of file tdehtml_part.cpp.
◆ selectedTextAsHTML()
TQString TDEHTMLPart::selectedTextAsHTML | ( | ) | const |
Return the text the user has marked.
This is guaranteed to be valid xml, and to contain the <html> and <body> tags.
FIXME probably should make virtual for 4.0 ?
- Since
- 3.4
Definition at line 3437 of file tdehtml_part.cpp.
◆ selection() [1/2]
DOM::Range TDEHTMLPart::selection | ( | ) | const |
Returns the selected part of the HTML.
Definition at line 3606 of file tdehtml_part.cpp.
◆ selection() [2/2]
void TDEHTMLPart::selection | ( | DOM::Node & | startNode, |
long & | startOffset, | ||
DOM::Node & | endNode, | ||
long & | endOffset | ||
) | const |
Returns the selected part of the HTML by returning the starting and end position.
If there is no selection, both nodes and offsets are equal.
- Parameters
-
startNode returns node selection starts in startOffset returns offset within starting node endNode returns node selection ends in endOffset returns offset within end node.
- Since
- 3.2
Definition at line 3660 of file tdehtml_part.cpp.
◆ selectionChanged
|
signal |
This signal is emitted when the selection changes.
◆ setActiveNode
|
slot |
Sets the focused node of the document to the specified node.
If the node is a form control, the control will receive focus in the same way that it would if the user had clicked on it or tabbed to it with the keyboard. For most other types of elements, there is no visual indication of whether or not they are focused.
See activeNode
- Parameters
-
node The node to focus
Definition at line 6924 of file tdehtml_part.cpp.
◆ setAutoloadImages()
void TDEHTMLPart::setAutoloadImages | ( | bool | enable | ) |
Specifies whether images contained in the document should be loaded automatically or not.
- Note
- Request will be ignored if called before begin().
Definition at line 1335 of file tdehtml_part.cpp.
◆ setCaretDisplayPolicyNonFocused()
void TDEHTMLPart::setCaretDisplayPolicyNonFocused | ( | CaretDisplayPolicy | policy | ) |
Sets the caret display policy when the view is not focused.
Whenever the caret is in use, this property determines how the caret should be displayed when the document view is not focused.
The default policy is CaretInvisible.
- Parameters
-
policy new display policy
- Since
- 3.2
Definition at line 2711 of file tdehtml_part.cpp.
◆ setCaretMode
|
slot |
Enables/disables caret mode.
Enabling caret mode displays a caret which can be used to navigate the document using the keyboard only. Caret mode is switched off by default.
- Parameters
-
enable true
to enable,false
to disable caret mode.
- Since
- 3.2
Definition at line 2645 of file tdehtml_part.cpp.
◆ setCaretPosition()
void TDEHTMLPart::setCaretPosition | ( | DOM::Node | node, |
long | offset, | ||
bool | extendSelection = false |
||
) |
Sets the caret to the given position.
If the given location is invalid, it will snap to the nearest valid location. Immediately afterwards a caretPositionChanged
signal containing the effective position is emitted
- Parameters
-
node node to set to offset zero-based offset within the node extendSelection If true
, a selection will be spanned from the last caret position to the given one. Otherwise, any existing selection will be deselected.
- Since
- 3.2
Definition at line 2688 of file tdehtml_part.cpp.
◆ setCaretVisible
|
slot |
Sets the visibility of the caret.
This methods displays or hides the caret regardless of the current caret display policy (see setCaretDisplayNonFocused), and regardless of focus.
The caret will be shown/hidden only under at least one of the following conditions:
- the document is editable
- the document is in caret mode
- the document's currently focused element is editable
- Parameters
-
show true
to make visible,false
to hide.
- Since
- 3.2
Definition at line 2718 of file tdehtml_part.cpp.
◆ setDNDEnabled()
void TDEHTMLPart::setDNDEnabled | ( | bool | b | ) |
Enables or disables Drag'n'Drop support.
A drag operation is started if the users drags a link.
Definition at line 5934 of file tdehtml_part.cpp.
◆ setEditable
|
slot |
Makes the document editable.
Setting this property to true
makes the document, and its subdocuments (such as frames, iframes, objects) editable as a whole. FIXME: insert more information about navigation, features etc. as seen fit
- Parameters
-
enable true
to set document editable,false
to set it read-only.
- Since
- 3.2 (pending, do not use)
Definition at line 2667 of file tdehtml_part.cpp.
◆ setEncoding()
bool TDEHTMLPart::setEncoding | ( | const TQString & | name, |
bool | override = false |
||
) |
Sets the encoding the page uses.
This can be different from the charset. The widget will try to reload the current page in the new encoding, if url() is not empty.
Definition at line 2467 of file tdehtml_part.cpp.
◆ setFixedFont()
void TDEHTMLPart::setFixedFont | ( | const TQString & | name | ) |
Sets the fixed font style.
- Parameters
-
name The font name to use for fixed text, e.g. the <pre>
tag.
Definition at line 2592 of file tdehtml_part.cpp.
◆ setFormNotification()
void TDEHTMLPart::setFormNotification | ( | TDEHTMLPart::FormNotification | fn | ) |
Determine if signal should be emitted before, instead or never when a submitForm() happens.
- Since
- 3.2
KDE4 remove me
Definition at line 7330 of file tdehtml_part.cpp.
◆ setJavaEnabled()
void TDEHTMLPart::setJavaEnabled | ( | bool | enable | ) |
Enables/disables Java applet support.
Note that calling this function will permanently override the User settings about Java applet support. Not calling this function is the only way to let the default settings apply.
Definition at line 1244 of file tdehtml_part.cpp.
◆ setJScriptEnabled()
void TDEHTMLPart::setJScriptEnabled | ( | bool | enable | ) |
Enable/disable Javascript support.
Note that this will in either case permanently override the default usersetting. If you want to have the default UserSettings, don't call this method.
Definition at line 930 of file tdehtml_part.cpp.
◆ setJSDefaultStatusBarText()
void TDEHTMLPart::setJSDefaultStatusBarText | ( | const TQString & | text | ) |
Called by KJS.
Sets the DefaultStatusBarText assigned via window.defaultStatus
Definition at line 5794 of file tdehtml_part.cpp.
◆ setJSStatusBarText()
void TDEHTMLPart::setJSStatusBarText | ( | const TQString & | text | ) |
Called by KJS.
Sets the StatusBarText assigned via window.status
Definition at line 5789 of file tdehtml_part.cpp.
◆ setMetaRefreshEnabled()
void TDEHTMLPart::setMetaRefreshEnabled | ( | bool | enable | ) |
Enable/disable automatic forwarding by <meta http-equiv="refresh" ....
>
Definition at line 948 of file tdehtml_part.cpp.
◆ setOnlyLocalReferences()
void TDEHTMLPart::setOnlyLocalReferences | ( | bool | enable | ) |
Security option.
Specify whether only file:/ or data:/ urls are allowed to be loaded without user confirmation by TDEHTML. ( for example referenced by stylesheets, images, scripts, subdocuments, embedded elements ).
This option is mainly intended for enabling the "mail reader mode", where you load untrusted content with a file:/ url.
Please note that enabling this option currently automatically disables Javascript, Java and Plugins support. This might change in the future if the security model is becoming more sophisticated, so don't rely on this behaviour.
( default false - everything is loaded unless forbidden by TDEApplication::authorizeURLAction).
Definition at line 2612 of file tdehtml_part.cpp.
◆ setPluginsEnabled()
void TDEHTMLPart::setPluginsEnabled | ( | bool | enable | ) |
Enables or disables plugins, default is enabled.
Definition at line 1273 of file tdehtml_part.cpp.
◆ setSelection()
void TDEHTMLPart::setSelection | ( | const DOM::Range & | r | ) |
Sets the current selection.
Definition at line 3668 of file tdehtml_part.cpp.
◆ setStandardFont()
void TDEHTMLPart::setStandardFont | ( | const TQString & | name | ) |
Sets the standard font style.
- Parameters
-
name The font name to use for standard text.
Definition at line 2587 of file tdehtml_part.cpp.
◆ setStatusMessagesEnabled()
void TDEHTMLPart::setStatusMessagesEnabled | ( | bool | enable | ) |
Enable/disable statusbar messages.
When this class wants to set the statusbar text, it emits setStatusBarText(const TQString & text) If you want to catch this for your own statusbar, note that it returns back a rich text string, starting with "<qt>". This you need to either pass this into your own TQLabel or to strip out the tags before passing it to TQStatusBar::message(const TQString & message)
Definition at line 911 of file tdehtml_part.cpp.
◆ setSuppressedPopupIndicator() [1/2]
void TDEHTMLPart::setSuppressedPopupIndicator | ( | bool | enable | ) |
Shows or hides the suppressed popup indicator.
- Since
- 3.4
Definition at line 7373 of file tdehtml_part.cpp.
◆ setSuppressedPopupIndicator() [2/2]
void TDEHTMLPart::setSuppressedPopupIndicator | ( | bool | enable, |
TDEHTMLPart * | originPart | ||
) |
Shows or hides the suppressed popup indicator.
- Since
- 3.5
Definition at line 7378 of file tdehtml_part.cpp.
◆ setURLCursor()
void TDEHTMLPart::setURLCursor | ( | const TQCursor & | c | ) |
Sets the cursor to use when the cursor is on a link.
Definition at line 2597 of file tdehtml_part.cpp.
◆ setUserStyleSheet() [1/2]
void TDEHTMLPart::setUserStyleSheet | ( | const KURL & | url | ) |
Sets a user defined style sheet to be used on top of the HTML 4 default style sheet.
This gives a wide range of possibilities to change the layout of the page.
To have an effect this function has to be called after calling begin().
Definition at line 2509 of file tdehtml_part.cpp.
◆ setUserStyleSheet() [2/2]
void TDEHTMLPart::setUserStyleSheet | ( | const TQString & | styleSheet | ) |
Sets a user defined style sheet to be used on top of the HTML 4 default style sheet.
This gives a wide range of possibilities to change the layout of the page.
To have an effect this function has to be called after calling begin().
Definition at line 2515 of file tdehtml_part.cpp.
◆ setZoomFactor()
void TDEHTMLPart::setZoomFactor | ( | int | percent | ) |
Sets the Zoom factor.
The value is given in percent, larger values mean a generally larger font and larger page contents. It is not guaranteed that all parts of the page are scaled with the same factor though.
The given value should be in the range of 20..300, values outside that range are not guaranteed to work. A value of 100 will disable all zooming and show the page with the sizes determined via the given lengths in the stylesheets.
Definition at line 5728 of file tdehtml_part.cpp.
◆ show()
void TDEHTMLPart::show | ( | void | ) |
◆ showError()
|
virtual |
Called when a certain error situation (i.e.
connection timed out) occurred. The default implementation either shows a TDEIO error dialog or loads a more verbose error description a as page, depending on the users configuration. job
is the job that signaled the error situation
Definition at line 1702 of file tdehtml_part.cpp.
◆ statusMessagesEnabled()
bool TDEHTMLPart::statusMessagesEnabled | ( | ) | const |
Returns true
if status messages are enabled.
Definition at line 925 of file tdehtml_part.cpp.
◆ stopAnimations
|
slot |
Stops all animated images on the current and child pages.
Definition at line 2055 of file tdehtml_part.cpp.
◆ tdehtmlDrawContentsEvent()
|
protectedvirtual |
Eventhandler for the tdehtml::DrawContentsEvent.
Definition at line 6632 of file tdehtml_part.cpp.
◆ tdehtmlMouseDoubleClickEvent()
|
protectedvirtual |
Eventhandler for the tdehtml::MouseDoubleClickEvent.
Definition at line 6129 of file tdehtml_part.cpp.
◆ tdehtmlMouseMoveEvent()
|
protectedvirtual |
Eventhandler for the tdehtml::MouseMouseMoveEvent.
Definition at line 6379 of file tdehtml_part.cpp.
◆ tdehtmlMousePressEvent()
|
protectedvirtual |
Eventhandler of the tdehtml::MousePressEvent.
Definition at line 6049 of file tdehtml_part.cpp.
◆ tdehtmlMouseReleaseEvent()
|
protectedvirtual |
Eventhandler for the tdehtml::MouseMouseReleaseEvent.
Definition at line 6518 of file tdehtml_part.cpp.
◆ toplevelURL()
KURL TDEHTMLPart::toplevelURL | ( | ) |
Returns the toplevel (origin) URL of this document, even if this part is a frame or an iframe.
- Returns
- the actual original url.
- Since
- 3.2
Definition at line 7338 of file tdehtml_part.cpp.
◆ urlCursor()
TQCursor TDEHTMLPart::urlCursor | ( | ) | const |
Returns the cursor which is used when the cursor is on a link.
Definition at line 2602 of file tdehtml_part.cpp.
◆ view()
TDEHTMLView * TDEHTMLPart::view | ( | ) | const |
Returns a pointer to the HTML document's view.
Definition at line 906 of file tdehtml_part.cpp.
◆ write() [1/2]
|
virtual |
Writes another part of the HTML code to the widget.
You may call this function many times in sequence. But remember: The fewer calls you make, the faster the widget will be.
The HTML code is send through a decoder which decodes the stream to Unicode.
The len
parameter is needed for streams encoded in utf-16, since these can have \0 chars in them. In case the encoding you're using isn't utf-16, you can safely leave out the length parameter.
Attention: Don't mix calls to write( const char *) with calls to write( const TQString & ).
The result might not be what you want.
Definition at line 1963 of file tdehtml_part.cpp.
◆ write() [2/2]
|
virtual |
Writes another part of the HTML code to the widget.
You may call this function many times in sequence. But remember: The fewer calls you make, the faster the widget will be.
Definition at line 1995 of file tdehtml_part.cpp.
◆ zoomFactor()
int TDEHTMLPart::zoomFactor | ( | ) | const |
Returns the current zoom factor.
Definition at line 5664 of file tdehtml_part.cpp.
The documentation for this class was generated from the following files: