KParts::OpenUrlArguments

#include <KParts/OpenUrlArguments>

Public Member Functions
	OpenUrlArguments (const OpenUrlArguments &other)

bool	actionRequestedByUser () const

QMap< QString, QString > &	metaData ()

const QMap< QString, QString > &	metaData () const

QString	mimeType () const

OpenUrlArguments &	operator= (const OpenUrlArguments &other)

bool	reload () const

void	setActionRequestedByUser (bool userRequested)

void	setMimeType (const QString &mime)

void	setReload (bool b)

void	setXOffset (int x)

void	setYOffset (int y)

int	xOffset () const

int	yOffset () const

Detailed Description

OpenUrlArguments is the set of arguments that specify how a URL should be opened by KParts::ReadOnlyPart::openUrl().

For instance reload() indicates that the url should be loaded from the network even if it matches the current url of the part.

All setter methods in this class are for the class that calls openUrl (usually the hosting application), all the getter methods are for the part.

Definition at line 34 of file openurlarguments.h.

Constructor & Destructor Documentation

◆ OpenUrlArguments() [1/2]

KParts::OpenUrlArguments::OpenUrlArguments ( )

Definition at line 22 of file openurlarguments.cpp.

◆ OpenUrlArguments() [2/2]

KParts::OpenUrlArguments::OpenUrlArguments ( const OpenUrlArguments & other )

Definition at line 27 of file openurlarguments.cpp.

◆ ~OpenUrlArguments()

KParts::OpenUrlArguments::~OpenUrlArguments ( )

Definition at line 38 of file openurlarguments.cpp.

Member Function Documentation

◆ actionRequestedByUser()

bool KParts::OpenUrlArguments::actionRequestedByUser ( ) const

True if the user requested that the URL be opened.

False if the URL should be opened due to an external event, like javascript popups or automatic redirections. This is true by default

Since: 4.1

Definition at line 92 of file openurlarguments.cpp.

◆ metaData() [1/2]

QMap< QString, QString > & KParts::OpenUrlArguments::metaData ( )

Meta-data to associate with the KIO operation that will be used to open the URL.

This method can be used to add or retrieve metadata.

See also: KIO::TransferJob etc.

Definition at line 82 of file openurlarguments.cpp.

◆ metaData() [2/2]

const QMap< QString, QString > & KParts::OpenUrlArguments::metaData ( ) const

Definition at line 87 of file openurlarguments.cpp.

◆ mimeType()

QString KParts::OpenUrlArguments::mimeType ( ) const

The mimetype to use when opening the url, when known by the calling application.

Definition at line 72 of file openurlarguments.cpp.

◆ operator=()

KParts::OpenUrlArguments & KParts::OpenUrlArguments::operator= ( const OpenUrlArguments & other )

Definition at line 32 of file openurlarguments.cpp.

◆ reload()

bool KParts::OpenUrlArguments::reload ( ) const

Returns: true to indicate that the part should reload the URL, i.e. the cache shouldn't be used (forced reload).

Definition at line 42 of file openurlarguments.cpp.

◆ setActionRequestedByUser()

void KParts::OpenUrlArguments::setActionRequestedByUser ( bool userRequested )

Definition at line 97 of file openurlarguments.cpp.

◆ setMimeType()

void KParts::OpenUrlArguments::setMimeType ( const QString & mime )

Definition at line 77 of file openurlarguments.cpp.

◆ setReload()

void KParts::OpenUrlArguments::setReload ( bool b )

Indicates that the url should be loaded from the network even if it matches the current url of the part.

Definition at line 47 of file openurlarguments.cpp.

◆ setXOffset()

void KParts::OpenUrlArguments::setXOffset ( int x )

Definition at line 57 of file openurlarguments.cpp.

◆ setYOffset()

void KParts::OpenUrlArguments::setYOffset ( int y )

Definition at line 67 of file openurlarguments.cpp.

◆ xOffset()

int KParts::OpenUrlArguments::xOffset ( ) const

xOffset 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 52 of file openurlarguments.cpp.

◆ yOffset()

int KParts::OpenUrlArguments::yOffset ( ) const

yOffset is the vertical scrolling of the part's widget (in case it's a scrollview).