KParts::OpenUrlArguments

Search for usage in LXR

KParts::OpenUrlArguments Class Reference

#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
 
OpenUrlArgumentsoperator= (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.

Member Function Documentation

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.

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.

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.

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.

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.

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.

int KParts::OpenUrlArguments::yOffset ( ) const

yOffset is the vertical 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 62 of file openurlarguments.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Oct 22 2021 22:56:45 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.