.PP
.TH "KParts::URLArgs" 3 "28 Jan 2004" "kparts Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KParts::URLArgs \- \fBURLArgs\fP is a set of arguments bundled into a structure, to allow specifying how a URL should be opened by openURL().  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <browserextension.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBURLArgs\fP (const  \fBURLArgs\fP &args)"
.br
.ti -1c
.RI "\fBURLArgs\fP & \fBoperator=\fP (const  \fBURLArgs\fP &args)"
.br
.ti -1c
.RI "\fBURLArgs\fP (bool \fBreload\fP, int \fBxOffset\fP, int \fByOffset\fP, const  \fBQString\fP &\fBserviceType\fP=QString::null)"
.br
.ti -1c
.RI "void \fBsetContentType\fP (const  \fBQString\fP &contentType)"
.br
.RI "\fIKHTML-specific field, header defining the type of the POST data. \fP"
.ti -1c
.RI "\fBQString\fP \fBcontentType\fP () const "
.br
.RI "\fIKHTML-specific field, header defining the type of the POST data. \fP"
.ti -1c
.RI "void \fBsetDoPost\fP (bool enable)"
.br
.RI "\fIKHTML-specific field, whether to do a POST instead of a GET, for the next openURL. \fP"
.ti -1c
.RI "bool \fBdoPost\fP () const "
.br
.RI "\fIKHTML-specific field, whether to do a POST instead of a GET, for the next openURL. \fP"
.ti -1c
.RI "void \fBsetLockHistory\fP (bool lock)"
.br
.RI "\fIWhether to lock the history when opening the next URL. \fP"
.ti -1c
.RI "bool \fBlockHistory\fP () const "
.br
.ti -1c
.RI "void \fBsetNewTab\fP (bool newTab)"
.br
.RI "\fIWhether the URL should be opened in a new tab instead in a new window. \fP"
.ti -1c
.RI "bool \fBnewTab\fP () const "
.br
.ti -1c
.RI "\fBQMap\fP< \fBQString\fP, \fBQString\fP > & \fBmetaData\fP ()"
.br
.RI "\fIMeta-data to associate with the next \fBKIO\fP operation. \fP"
.ti -1c
.RI "bool \fBredirectedRequest\fP () const "
.br
.ti -1c
.RI "void \fBsetRedirectedRequest\fP (bool redirected)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBQStringList\fP \fBdocState\fP"
.br
.RI "\fIThis buffer can be used by the part to save and restore its contents. \fP"
.ti -1c
.RI "bool \fBreload\fP"
.br
.RI "\fI\fCreload\fP is set when the cache shouldn't be used (forced reload). \fP"
.ti -1c
.RI "int \fBxOffset\fP"
.br
.RI "\fI\fCxOffset\fP is the horizontal scrolling of the part's widget (in case it's a scrollview). \fP"
.ti -1c
.RI "int \fByOffset\fP"
.br
.RI "\fI\fCyOffset\fP vertical scrolling position, \fBxOffset\fP. \fP"
.ti -1c
.RI "\fBQString\fP \fBserviceType\fP"
.br
.RI "\fIThe servicetype (usually mimetype) to use when opening the next URL. \fP"
.ti -1c
.RI "\fBQByteArray\fP \fBpostData\fP"
.br
.RI "\fIKHTML-specific field, contents of the HTTP POST data. \fP"
.ti -1c
.RI "\fBQString\fP \fBframeName\fP"
.br
.RI "\fIThe frame in which to open the URL. \fP"
.ti -1c
.RI "bool \fBtrustedSource\fP"
.br
.RI "\fIIf true, the part who asks for a URL to be opened can be 'trusted' to execute applications. \fP"
.ti -1c
.RI "URLArgsPrivate * \fBd\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBURLArgs\fP is a set of arguments bundled into a structure, to allow specifying how a URL should be opened by openURL(). 

In other words, this is like arguments to openURL(), but without have to change the signature of openURL() (since openURL is a generic KParts method). The parts (with a browser extension) who care about urlargs will use those arguments, others will ignore them.
.PP
This can also be used the other way round, when a part asks for a URL to be opened (with openURLRequest or createNewWindow). 
.PP
Definition at line 56 of file browserextension.h.
.SH "Member Function Documentation"
.PP 
.SS "void URLArgs::setContentType (const \fBQString\fP & contentType)"
.PP
KHTML-specific field, header defining the type of the POST data. Definition at line 128 of file browserextension.cpp.
.SS "\fBQString\fP URLArgs::contentType () const"
.PP
KHTML-specific field, header defining the type of the POST data. Definition at line 147 of file browserextension.cpp.
.SS "void URLArgs::setDoPost (bool enable)"
.PP
KHTML-specific field, whether to do a POST instead of a GET, for the next openURL. Definition at line 159 of file browserextension.cpp.
.SS "bool URLArgs::doPost () const"
.PP
KHTML-specific field, whether to do a POST instead of a GET, for the next openURL. Definition at line 166 of file browserextension.cpp.
.SS "void URLArgs::setLockHistory (bool lock)"
.PP
Whether to lock the history when opening the next URL. This is used during e.g. a redirection, to avoid a new entry in the history. Definition at line 171 of file browserextension.cpp.
.SS "void URLArgs::setNewTab (bool newTab)"
.PP
Whether the URL should be opened in a new tab instead in a new window. Definition at line 183 of file browserextension.cpp.
.SS "\fBQMap\fP< \fBQString\fP, \fBQString\fP > & URLArgs::metaData ()"
.PP
Meta-data to associate with the next \fBKIO\fP operation. \fBSee also:\fP
.RS 4
\fBKIO::TransferJob\fP etc. 
.RE
.PP
Definition at line 152 of file browserextension.cpp.
.SH "Member Data Documentation"
.PP 
.SS "\fBQStringList\fP \fBKParts::URLArgs::docState\fP"
.PP
This buffer can be used by the part to save and restore its contents. See KHTMLPart for instance. Definition at line 69 of file browserextension.h.
.SS "bool \fBKParts::URLArgs::reload\fP"
.PP
\fCreload\fP is set when the cache shouldn't be used (forced reload). Definition at line 74 of file browserextension.h.
.SS "int \fBKParts::URLArgs::xOffset\fP"
.PP
\fCxOffset\fP is the horizontal scrolling of the part's widget (in case it's a scrollview). This is saved into the history and restored when going back in the history. Definition at line 80 of file browserextension.h.
.PP
Referenced by KParts::BrowserExtension::restoreState().
.SS "int \fBKParts::URLArgs::yOffset\fP"
.PP
\fCyOffset\fP vertical scrolling position, \fBxOffset\fP. Definition at line 84 of file browserextension.h.
.PP
Referenced by KParts::BrowserExtension::restoreState().
.SS "\fBQString\fP \fBKParts::URLArgs::serviceType\fP"
.PP
The servicetype (usually mimetype) to use when opening the next URL. Definition at line 88 of file browserextension.h.
.SS "\fBQByteArray\fP \fBKParts::URLArgs::postData\fP"
.PP
KHTML-specific field, contents of the HTTP POST data. Definition at line 93 of file browserextension.h.
.SS "\fBQString\fP \fBKParts::URLArgs::frameName\fP"
.PP
The frame in which to open the URL. KHTML/Konqueror-specific. Definition at line 136 of file browserextension.h.
.SS "bool \fBKParts::URLArgs::trustedSource\fP"
.PP
If true, the part who asks for a URL to be opened can be 'trusted' to execute applications. For instance, the directory views can be 'trusted' whereas HTML pages are not trusted in that respect. Definition at line 143 of file browserextension.h.

.SH "Author"
.PP 
Generated automatically by Doxygen for kparts Library from the source code.
