• Home
• Kimono
• KHTMLPart

C# Class Kimono.KHTMLPart

Show file Open project: 0xd34df00d/Qross Class Usage Examples

Private Properties

Property	Type	Description
Begin	void
Begin	void
Begin	void
Begin	void
CloseUrl	bool
CreatePart	KParts.ReadOnlyPart
CustomEvent	void
DoCloseStream	bool
DoOpenStream	bool
DoWriteStream	bool
End	void
GuiActivateEvent	void
OpenFile	bool
OpenUrl	bool
RestoreState	void
SaveState	void
SelectedText	string
SetActiveNode	void
SetCaretMode	void
SetCaretVisible	void
SetEditable	void
ShowError	void
SlotFinished	void
StartingJob	void
StopAnimations	void
SubmitFormProxy	void
SubmitFormProxy	void
SubmitFormProxy	void
TimerEvent	void
UrlSelected	bool
UrlSelected	bool
UrlSelected	bool
Write	void
Write	void

Public Methods

Method	Description
ActiveNode ( ) : DOM.Node	Returns the node that has the keyboard focus.
AutoloadImages ( ) : bool	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.
BackgroundURL ( ) : Kimono.KUrl	Returns the URL for the background Image (used by save background)
BaseURL ( ) : Kimono.KUrl
BrowserExtension ( ) : KParts.BrowserExtension	Returns a pointer to the KParts.BrowserExtension.
BrowserHostExtension ( ) : KParts.BrowserHostExtension
CaretDisplayPolicyNonFocused ( ) : KHTMLPart.CaretDisplayPolicy	Returns the current caret policy when the view is not focused.
CurrentFrame ( ) : KParts.ReadOnlyPart	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.
Dispose ( ) : void
Document ( ) : DOM.Document	Returns a reference to the DOM document.
DocumentSource ( ) : string	Returns the content of the source document.
ExecuteScript ( DOM n, string script ) : Qyoto.QVariant	Same as executeScript( string ) except with the Node parameter specifying the 'this' value.
FindFrame ( string f ) : KHTMLPart	Finds a frame by name. Returns null if frame can't be found.
FindFrameParent ( KParts callingPart, string f ) : KHTMLPart	Recursively finds the part containing the frame with name f and checks if it is accessible by callingPart Returns null if no suitable frame can't be found. Returns parent part if a suitable frame was found and frame info in childFrame
FindFramePart ( string f ) : KParts.ReadOnlyPart	Returns child frame framePart its script interpreterFinds a frame by name. Returns null if frame can't be found.
FindText ( ) : void	Starts a new search by popping up a dialog asking the user what he wants to search for.
FindText ( string str, long options ) : void
FindText ( string str, long options, QWidget parent ) : void
FindText ( string str, long options, QWidget parent, Kimono.KFindDialog findDialog ) : void	Starts a new search, but bypasses the user dialog. name="str" The string to search for. name="options" Find options. name="parent" Parent used for centering popups like "string not found". name="findDialog" Optionally, you can supply your own dialog.
FindTextBegin ( ) : void	Initiates a text search.
FindTextNext ( ) : bool
FindTextNext ( bool reverse ) : bool	Finds the next occurrence of a string set by name="reverse" if true, revert seach direction (only if no find dialog is used)
FontScaleFactor ( ) : int	Returns the current font scale factor.
FrameExists ( string frameName ) : bool	Returns whether a frame with the specified name is exists or not. In contrast to the findFrame method this one also returns true if the frame is defined but no displaying component has been found/loaded, yet.
FrameNames ( ) : List	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.
Frames ( ) : List
GotoAnchor ( string name ) : bool	Finds the anchor named name. If the anchor is found, the widget scrolls to the closest position. Returns if the anchor has been found.
HasSelection ( ) : bool	Has the user selected anything? Call selectedText() to retrieve the selected text.
Hide ( ) : void	Convenience method to hide the document's view. Equivalent to widget().Hide() or view().Hide().
HtmlDocument ( ) : DOM.HTMLDocument	Returns a reference to the DOM HTML document (for non-HTML documents, returns null)
InProgress ( ) : bool
IsCaretMode ( ) : bool	Returns whether caret mode is on/off.
IsEditable ( ) : bool	Returns true if the document is editable, false otherwise.
IsPointInsideSelection ( int x, int y ) : bool	Returns whether the given point is inside the current selection. The coordinates are content-coordinates.
JsDefaultStatusBarText ( ) : string	Called by KJS. Returns the DefaultStatusBarText assigned via window.defaultStatus
JsStatusBarText ( ) : string	Called by KJS. Returns the StatusBarText assigned via window.status
KHTMLPart ( ) : System
KHTMLPart ( Kimono.KHTMLView view ) : System
KHTMLPart ( Kimono.KHTMLView view, QObject parent ) : System
KHTMLPart ( Kimono.KHTMLView view, QObject parent, KHTMLPart prof ) : System	Constructs a new KHTMLPart. This constructor is useful if you wish to subclass KHTMLView. If the view passed as first argument to the constructor was built with a null KHTMLPart pointer, then the newly created KHTMLPart will be assigned as the view's part. Therefore, you might either initialize the view as part of the initialization list of your derived KHTMLPart class constructor: MyKHTMLPart(), ... Or separately build the KHTMLView beforehand: KHTMLView v = KHTMLView( null, parentWidget()); KHTMLPart p = KHTMLPart( v ); // p will be assigned to v, so that v.Part() == p
KHTMLPart ( QWidget parentWidget ) : System
KHTMLPart ( QWidget parentWidget, QObject parent ) : System
KHTMLPart ( QWidget parentWidget, QObject parent, KHTMLPart prof ) : System	Constructs a new KHTMLPart. KHTML basically consists of two objects: The KHTMLPart itself, holding the document data (DOM document), and the KHTMLView, derived from QScrollArea, in which the document content is rendered in. You can specify two different parent objects for a KHTMLPart, one parent for the KHTMLPart document and one parent for the KHTMLView. If the second parent argument is null, then parentWidget is used as parent for both objects, the part and the view.
NextAnchor ( ) : bool	Go to the next anchor This is useful to navigate from outside the navigator
NodeUnderMouse ( ) : DOM.Node	Returns the Node currently under the mouse. The returned node may be a shared node (e. g. an \ node if the mouse is hovering over an image map).
NonSharedNodeUnderMouse ( ) : DOM.Node	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., \ on image maps).
OnlyLocalReferences ( ) : bool	Returns whether only file:/ or data:/ references are allowed to be loaded ( default false ). See setOnlyLocalReferences.
PageReferrer ( ) : string	Referrer used to obtain this page.
Paint ( QPainter arg1, Qyoto.QRect arg2 ) : void
Paint ( QPainter arg1, Qyoto.QRect arg2, int arg3 ) : void
Paint ( QPainter arg1, Qyoto.QRect arg2, int arg3, bool &arg4 ) : void	Paints the HTML page to a QPainter. See KHTMLView.Paint for details
ParentPart ( ) : KHTMLPart	Returns a pointer to the parent KHTMLPart if the part is a frame in an HTML frameset. Returns null otherwise.
PartManager ( ) : KParts.PartManager	Returns a reference to the partmanager instance which manages html frame objects.
PreloadScript ( string url, string script ) : void	Loads a script into the script cache.
PreloadStyleSheet ( string url, string stylesheet ) : void	Loads a style sheet into the stylesheet cache.
PrevAnchor ( ) : bool	Go to previous anchor
Referrer ( ) : string	Referrer used for links in this page.
Restored ( ) : bool
ScheduleRedirection ( int delay, string url ) : void
ScheduleRedirection ( int delay, string url, bool lockHistory ) : void	Schedules a redirection after delay seconds.
SelectAll ( ) : void	Returns the instance of the attached html editor interface.Marks all text in the document as selected.
SelectedTextAsHTML ( ) : string	Return the text the user has marked. This is guaranteed to be valid xml, and to contain the \ and \ tags. FIXME probably should make for 4.0 ?
Selection ( ) : DOM.Range	Returns the selected part of the HTML.
Selection ( DOM startNode, long startOffset, DOM endNode, long endOffset ) : void	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. name="startNode" returns node selection starts in name="startOffset" returns offset within starting node name="endNode" returns node selection ends in name="endOffset" returns offset within end node.
SetAlwaysHonourDoctype ( ) : void
SetAlwaysHonourDoctype ( bool b ) : void	Sets whether the document's Doctype should always be used to determine the parsing mode for the document. Without this, parsing will be forced to strict mode when using the write( stringstr ) method for backward compatibility reasons.
SetAutoloadImages ( bool enable ) : void	Specifies whether images contained in the document should be loaded automatically or not. @note Request will be ignored if called before begin().
SetCaretDisplayPolicyNonFocused ( KHTMLPart policy ) : void	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. name="policy" new display policy
SetCaretPosition ( DOM node, long offset ) : void
SetCaretPosition ( DOM node, long offset, bool extendSelection ) : void	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 name="node" node to set to name="offset" zero-based offset within the node name="extendSelection" If true, a selection will be spanned from the last caret position to the given one. Otherwise, any existing selection will be deselected.
SetEncoding ( string name ) : bool
SetEncoding ( string name, bool arg2 ) : bool	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.
SetFixedFont ( string name ) : void	Sets the fixed font style. name="name" The font name to use for fixed text, e.g. the <pre> tag.
SetFontScaleFactor ( int percent ) : void	Sets the scale factor to be applied to fonts. The value is given in percent, larger values mean generally larger fonts. 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 scaling of font sizes and show the page with the sizes determined via the given lengths in the stylesheets.
SetFormNotification ( KHTMLPart fn ) : void	Determine if signal should be emitted before, instead or never when a submitForm() happens. ### KDE5 remove me
SetJSDefaultStatusBarText ( string text ) : void	Called by KJS. Sets the DefaultStatusBarText assigned via window.defaultStatus
SetJSStatusBarText ( string text ) : void	Called by KJS. Sets the StatusBarText assigned via window.status
SetOnlyLocalReferences ( bool enable ) : void	Security option. Specify whether only file:/ or data:/ urls are allowed to be loaded without user confirmation by KHTML. ( 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 KApplication.AuthorizeURLAction).
SetSelection ( DOM arg1 ) : void	Sets the current selection.
SetStandardFont ( string name ) : void	Sets the standard font style. name="name" The font name to use for standard text.
SetStatusMessagesEnabled ( bool enable ) : void	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( KUrl, int, int ) method, and the openUrl( 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 every time this happens - one way to detect the need for this is to connect to the docCreated() signal, another is to reimplement the begin() method.Enable/disable statusbar messages. When this class wants to set the statusbar text, it emits setStatusBarText(string text) If you want to catch this for your own statusbar, note that it returns back a rich text string, starting with "". This you need to either pass this into your own QLabel or to strip out the tags before passing it to QStatusBar.Message(string message)
SetSuppressedPopupIndicator ( bool enable ) : void
SetSuppressedPopupIndicator ( bool enable, KHTMLPart originPart ) : void	Shows or hides the suppressed popup indicator
SetURLCursor ( QCursor c ) : void	Sets the cursor to use when the cursor is on a link.
SetUserStyleSheet ( Kimono.KUrl url ) : void	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().
SetUserStyleSheet ( string styleSheet ) : void	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().
SetZoomFactor ( int percent ) : void	Sets the Zoom factor. The value is given in percent, larger values mean a generally larger font and larger page contents. 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.
Settings ( ) : Kimono.KHTMLSettings
Show ( ) : void	Convenience method to show the document's view. Equivalent to widget().Show() or view().Show() .
StatusMessagesEnabled ( ) : bool	Returns true if status messages are enabled.
ToplevelURL ( ) : Kimono.KUrl	Returns the toplevel (origin) URL of this document, even if this part is a frame or an iframe.
UrlCursor ( ) : QCursor	Returns the cursor which is used when the cursor is on a link.
View ( ) : Kimono.KHTMLView	Returns a pointer to the HTML document's view.
ZoomFactor ( ) : int	Returns the current zoom factor.
formNotification ( ) : KHTMLPart.FormNotification	Determine if signal should be emitted before, instead or never when a submitForm() happens. ### KDE5 remove me

Protected Methods

Method	Description
CompleteURL ( string url ) : Kimono.KUrl	returns a KUrl object for the given url. Use when you know what you're doing.
CreateProxy ( ) : void
HtmlError ( int errorCode, string text, Kimono.KUrl reqUrl ) : void	presents a detailed error message to the user. errorCode kio error code, eg KIO.ERR_SERVER_TIMEOUT. text kio additional information text. url the url that triggered the error.
KHTMLPart ( Type dummy ) : System
PluginPageQuestionAsked ( string mimetype ) : bool
SetPluginPageQuestionAsked ( string mimetype ) : void

Private Methods

Method	Description
Begin ( ) : void
Begin ( Kimono.KUrl url ) : void
Begin ( Kimono.KUrl url, int xOffset ) : void
Begin ( Kimono.KUrl url, int xOffset, int yOffset ) : void
CloseUrl ( ) : bool
CreatePart ( QWidget parentWidget, QObject parent, string mimetype, StringBuilder serviceName, List serviceTypes, List arg6 ) : KParts.ReadOnlyPart
CustomEvent ( Qyoto.QEvent arg1 ) : void
DoCloseStream ( ) : bool
DoOpenStream ( string mimeType ) : bool
DoWriteStream ( Qyoto.QByteArray data ) : bool
End ( ) : void
GuiActivateEvent ( KParts arg1 ) : void
OpenFile ( ) : bool
OpenUrl ( Kimono.KUrl url ) : bool
RestoreState ( QDataStream stream ) : void
SaveState ( QDataStream stream ) : void
SelectedText ( ) : string
SetActiveNode ( DOM node ) : void
SetCaretMode ( bool enable ) : void
SetCaretVisible ( bool show ) : void
SetEditable ( bool enable ) : void
ShowError ( Kimono.KJob job ) : void
SlotFinished ( Kimono.KJob arg1 ) : void
StartingJob ( KIO arg1 ) : void
StopAnimations ( ) : void
SubmitFormProxy ( string action, string url, Qyoto.QByteArray formData, string target ) : void
SubmitFormProxy ( string action, string url, Qyoto.QByteArray formData, string target, string contentType ) : void
SubmitFormProxy ( string action, string url, Qyoto.QByteArray formData, string target, string contentType, string boundary ) : void
TimerEvent ( Qyoto.QTimerEvent arg1 ) : void
UrlSelected ( string url, int button, int state, string _target ) : bool
UrlSelected ( string url, int button, int state, string _target, KParts args ) : bool
UrlSelected ( string url, int button, int state, string _target, KParts args, KParts browserArgs ) : bool
Write ( string str ) : void
Write ( string str, int len ) : void

Method Details