\section{KParts::URLArgs Struct Reference}
\label{structKParts_1_1URLArgs}\index{KParts::URLArgs@{KParts::URLArgs}}
{\bf URLArgs}{\rm (p.\,\pageref{structKParts_1_1URLArgs})} is a set of arguments bundled into a structure, to allow specifying how a URL should be opened by open\-URL().  


{\tt \#include $<$browserextension.h$>$}

Collaboration diagram for KParts::URLArgs:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=153pt]{structKParts_1_1URLArgs__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf URLArgs} (const  {\bf URLArgs} \&args)\label{structKParts_1_1URLArgs_a1}

\item 
{\bf URLArgs} \& {\bf operator=} (const  {\bf URLArgs} \&args)\label{structKParts_1_1URLArgs_a2}

\item 
{\bf URLArgs} (bool {\bf reload}, int {\bf x\-Offset}, int {\bf y\-Offset}, const  {\bf QString} \&{\bf service\-Type}=QString::null)\label{structKParts_1_1URLArgs_a3}

\item 
void {\bf set\-Content\-Type} (const  {\bf QString} \&content\-Type)
\begin{CompactList}\small\item\em KHTML-specific field, header defining the type of the POST data. \item\end{CompactList}\item 
{\bf QString} {\bf content\-Type} () const 
\begin{CompactList}\small\item\em KHTML-specific field, header defining the type of the POST data. \item\end{CompactList}\item 
void {\bf set\-Do\-Post} (bool enable)
\begin{CompactList}\small\item\em KHTML-specific field, whether to do a POST instead of a GET, for the next open\-URL. \item\end{CompactList}\item 
bool {\bf do\-Post} () const 
\begin{CompactList}\small\item\em KHTML-specific field, whether to do a POST instead of a GET, for the next open\-URL. \item\end{CompactList}\item 
void {\bf set\-Lock\-History} (bool lock)
\begin{CompactList}\small\item\em Whether to lock the history when opening the next URL. \item\end{CompactList}\item 
bool {\bf lock\-History} () const \label{structKParts_1_1URLArgs_a10}

\item 
void {\bf set\-New\-Tab} (bool new\-Tab)
\begin{CompactList}\small\item\em Whether the URL should be opened in a new tab instead in a new window. \item\end{CompactList}\item 
bool {\bf new\-Tab} () const \label{structKParts_1_1URLArgs_a12}

\item 
{\bf QMap}$<$ {\bf QString}, {\bf QString} $>$ \& {\bf meta\-Data} ()
\begin{CompactList}\small\item\em Meta-data to associate with the next {\bf KIO} operation. \item\end{CompactList}\item 
bool {\bf redirected\-Request} () const \label{structKParts_1_1URLArgs_a14}

\item 
void {\bf set\-Redirected\-Request} (bool redirected)\label{structKParts_1_1URLArgs_a15}

\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
{\bf QString\-List} {\bf doc\-State}
\begin{CompactList}\small\item\em This buffer can be used by the part to save and restore its contents. \item\end{CompactList}\item 
bool {\bf reload}
\begin{CompactList}\small\item\em {\tt reload} is set when the cache shouldn't be used (forced reload). \item\end{CompactList}\item 
int {\bf x\-Offset}
\begin{CompactList}\small\item\em {\tt x\-Offset} is the horizontal scrolling of the part's widget (in case it's a scrollview). \item\end{CompactList}\item 
int {\bf y\-Offset}
\begin{CompactList}\small\item\em {\tt y\-Offset} vertical scrolling position, {\bf x\-Offset}{\rm (p.\,\pageref{structKParts_1_1URLArgs_o2})}. \item\end{CompactList}\item 
{\bf QString} {\bf service\-Type}
\begin{CompactList}\small\item\em The servicetype (usually mimetype) to use when opening the next URL. \item\end{CompactList}\item 
{\bf QByte\-Array} {\bf post\-Data}
\begin{CompactList}\small\item\em KHTML-specific field, contents of the HTTP POST data. \item\end{CompactList}\item 
{\bf QString} {\bf frame\-Name}
\begin{CompactList}\small\item\em The frame in which to open the URL. \item\end{CompactList}\item 
bool {\bf trusted\-Source}
\begin{CompactList}\small\item\em If true, the part who asks for a URL to be opened can be 'trusted' to execute applications. \item\end{CompactList}\item 
URLArgs\-Private $\ast$ {\bf d}\label{structKParts_1_1URLArgs_o8}

\end{CompactItemize}


\subsection{Detailed Description}
{\bf URLArgs}{\rm (p.\,\pageref{structKParts_1_1URLArgs})} is a set of arguments bundled into a structure, to allow specifying how a URL should be opened by open\-URL(). 

In other words, this is like arguments to open\-URL(), but without have to change the signature of open\-URL() (since open\-URL is a generic KParts method). The parts (with a browser extension) who care about urlargs will use those arguments, others will ignore them.

This can also be used the other way round, when a part asks for a URL to be opened (with open\-URLRequest or create\-New\-Window). 



Definition at line 56 of file browserextension.h.

\subsection{Member Function Documentation}
\index{KParts::URLArgs@{KParts::URLArgs}!setContentType@{setContentType}}
\index{setContentType@{setContentType}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void URLArgs::set\-Content\-Type (const {\bf QString} \& {\em content\-Type})}\label{structKParts_1_1URLArgs_a5}


KHTML-specific field, header defining the type of the POST data. 



Definition at line 128 of file browserextension.cpp.\index{KParts::URLArgs@{KParts::URLArgs}!contentType@{contentType}}
\index{contentType@{contentType}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} URLArgs::content\-Type () const}\label{structKParts_1_1URLArgs_a6}


KHTML-specific field, header defining the type of the POST data. 



Definition at line 147 of file browserextension.cpp.\index{KParts::URLArgs@{KParts::URLArgs}!setDoPost@{setDoPost}}
\index{setDoPost@{setDoPost}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void URLArgs::set\-Do\-Post (bool {\em enable})}\label{structKParts_1_1URLArgs_a7}


KHTML-specific field, whether to do a POST instead of a GET, for the next open\-URL. 



Definition at line 159 of file browserextension.cpp.\index{KParts::URLArgs@{KParts::URLArgs}!doPost@{doPost}}
\index{doPost@{doPost}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool URLArgs::do\-Post () const}\label{structKParts_1_1URLArgs_a8}


KHTML-specific field, whether to do a POST instead of a GET, for the next open\-URL. 



Definition at line 166 of file browserextension.cpp.\index{KParts::URLArgs@{KParts::URLArgs}!setLockHistory@{setLockHistory}}
\index{setLockHistory@{setLockHistory}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void URLArgs::set\-Lock\-History (bool {\em lock})}\label{structKParts_1_1URLArgs_a9}


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.\index{KParts::URLArgs@{KParts::URLArgs}!setNewTab@{setNewTab}}
\index{setNewTab@{setNewTab}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void URLArgs::set\-New\-Tab (bool {\em new\-Tab})}\label{structKParts_1_1URLArgs_a11}


Whether the URL should be opened in a new tab instead in a new window. 



Definition at line 183 of file browserextension.cpp.\index{KParts::URLArgs@{KParts::URLArgs}!metaData@{metaData}}
\index{metaData@{metaData}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QMap}$<$ {\bf QString}, {\bf QString} $>$ \& URLArgs::meta\-Data ()}\label{structKParts_1_1URLArgs_a13}


Meta-data to associate with the next {\bf KIO} operation. 

\begin{Desc}
\item[See also:]{\bf KIO::Transfer\-Job} etc. \end{Desc}


Definition at line 152 of file browserextension.cpp.

\subsection{Member Data Documentation}
\index{KParts::URLArgs@{KParts::URLArgs}!docState@{docState}}
\index{docState@{docState}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} {\bf KParts::URLArgs::doc\-State}}\label{structKParts_1_1URLArgs_o0}


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.\index{KParts::URLArgs@{KParts::URLArgs}!reload@{reload}}
\index{reload@{reload}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool {\bf KParts::URLArgs::reload}}\label{structKParts_1_1URLArgs_o1}


{\tt reload} is set when the cache shouldn't be used (forced reload). 



Definition at line 74 of file browserextension.h.\index{KParts::URLArgs@{KParts::URLArgs}!xOffset@{xOffset}}
\index{xOffset@{xOffset}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf KParts::URLArgs::x\-Offset}}\label{structKParts_1_1URLArgs_o2}


{\tt x\-Offset} 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.

Referenced by KParts::Browser\-Extension::restore\-State().\index{KParts::URLArgs@{KParts::URLArgs}!yOffset@{yOffset}}
\index{yOffset@{yOffset}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf KParts::URLArgs::y\-Offset}}\label{structKParts_1_1URLArgs_o3}


{\tt y\-Offset} vertical scrolling position, {\bf x\-Offset}{\rm (p.\,\pageref{structKParts_1_1URLArgs_o2})}. 



Definition at line 84 of file browserextension.h.

Referenced by KParts::Browser\-Extension::restore\-State().\index{KParts::URLArgs@{KParts::URLArgs}!serviceType@{serviceType}}
\index{serviceType@{serviceType}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} {\bf KParts::URLArgs::service\-Type}}\label{structKParts_1_1URLArgs_o4}


The servicetype (usually mimetype) to use when opening the next URL. 



Definition at line 88 of file browserextension.h.\index{KParts::URLArgs@{KParts::URLArgs}!postData@{postData}}
\index{postData@{postData}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QByte\-Array} {\bf KParts::URLArgs::post\-Data}}\label{structKParts_1_1URLArgs_o5}


KHTML-specific field, contents of the HTTP POST data. 



Definition at line 93 of file browserextension.h.\index{KParts::URLArgs@{KParts::URLArgs}!frameName@{frameName}}
\index{frameName@{frameName}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} {\bf KParts::URLArgs::frame\-Name}}\label{structKParts_1_1URLArgs_o6}


The frame in which to open the URL. 

KHTML/Konqueror-specific. 

Definition at line 136 of file browserextension.h.\index{KParts::URLArgs@{KParts::URLArgs}!trustedSource@{trustedSource}}
\index{trustedSource@{trustedSource}!KParts::URLArgs@{KParts::URLArgs}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool {\bf KParts::URLArgs::trusted\-Source}}\label{structKParts_1_1URLArgs_o7}


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.

The documentation for this struct was generated from the following files:\begin{CompactItemize}
\item 
browserextension.h\item 
browserextension.cpp\end{CompactItemize}
