• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KParts

KParts::OpenUrlArguments

KParts::OpenUrlArguments Class Reference

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

#include <part.h>

List of all members.

Public Member Functions

bool actionRequestedByUser () const
const QMap< QString, QString > & metaData () const
QMap< QString, QString > & metaData ()
QString mimeType () const
 OpenUrlArguments (const OpenUrlArguments &other)
 OpenUrlArguments ()
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
 ~OpenUrlArguments ()

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 404 of file part.h.


Constructor & Destructor Documentation

KParts::OpenUrlArguments::OpenUrlArguments (  ) 

Definition at line 1011 of file part.cpp.

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

Definition at line 1016 of file part.cpp.

KParts::OpenUrlArguments::~OpenUrlArguments (  ) 

Definition at line 1027 of file part.cpp.


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 1081 of file part.cpp.

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

Definition at line 1076 of file part.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 1071 of file part.cpp.

QString KParts::OpenUrlArguments::mimeType (  )  const

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

Definition at line 1061 of file part.cpp.

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

Definition at line 1021 of file part.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 1031 of file part.cpp.

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

Definition at line 1086 of file part.cpp.

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

Definition at line 1066 of file part.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 1036 of file part.cpp.

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

Definition at line 1046 of file part.cpp.

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

Definition at line 1056 of file part.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 1041 of file part.cpp.

int KParts::OpenUrlArguments::yOffset (  )  const

yOffset 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 1051 of file part.cpp.


The documentation for this class was generated from the following files:
  • part.h
  • part.cpp

KParts

Skip menu "KParts"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal