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

KParts

KParts::ReadOnlyPart

KParts::ReadOnlyPart Class Reference

#include <part.h>

Inheritance diagram for KParts::ReadOnlyPart:

Inheritance graph
[legend]

List of all members.


Detailed Description

Base class for any "viewer" part.

This class takes care of network transparency for you, in the simplest way (downloading to a temporary file, then letting the part load from the temporary file). To use the built-in network transparency, you only need to implement openFile(), not openUrl().

To implement network transparency differently (e.g. for progressive loading, like a web browser does for instance), or to prevent network transparency (but why would you do that?), you can override openUrl().

KParts Application can use the signals to show feedback while the URL is being loaded.

ReadOnlyPart handles the window caption by setting it to the current URL (set in openUrl(), and each time the part is activated). If you want another caption, set it in openFile() and (if the part might ever be used with a part manager) in guiActivateEvent()

Definition at line 488 of file part.h.


Public Slots

virtual bool openUrl (const KUrl &url)

Signals

void canceled (const QString &errMsg)
void completed (bool pendingAction)
void completed ()
void started (KIO::Job *)

Public Member Functions

OpenUrlArguments arguments () const
BrowserExtension * browserExtension () const
bool closeStream ()
virtual bool closeUrl ()
bool isProgressInfoEnabled () const
bool openStream (const QString &mimeType, const KUrl &url)
 ReadOnlyPart (QObject *parent=0)
void setArguments (const OpenUrlArguments &arguments)
void setProgressInfoEnabled (bool show)
void showProgressInfo (bool show)
KUrl url () const
bool writeStream (const QByteArray &data)
virtual ~ReadOnlyPart ()

Protected Member Functions

void abortLoad ()
virtual void guiActivateEvent (GUIActivateEvent *event)
bool isLocalFileTemporary () const
QString localFilePath () const
virtual bool openFile ()=0
 ReadOnlyPart (ReadOnlyPartPrivate &dd, QObject *parent)
void setLocalFilePath (const QString &localFilePath)
void setLocalFileTemporary (bool temp)
void setUrl (const KUrl &url)

Properties

KUrl url

Constructor & Destructor Documentation

ReadOnlyPart::ReadOnlyPart ( QObject *  parent = 0  )  [explicit]

Constructor See also Part for the setXXX methods to call.

Definition at line 447 of file part.cpp.

ReadOnlyPart::~ReadOnlyPart (  )  [virtual]

Destructor.

Definition at line 457 of file part.cpp.

ReadOnlyPart::ReadOnlyPart ( ReadOnlyPartPrivate &  dd,
QObject *  parent 
) [protected]

Definition at line 452 of file part.cpp.


Member Function Documentation

void ReadOnlyPart::abortLoad (  )  [protected]

Definition at line 594 of file part.cpp.

OpenUrlArguments KParts::ReadOnlyPart::arguments (  )  const

Returns:
the arguments that were used to open this URL.

Definition at line 702 of file part.cpp.

BrowserExtension * ReadOnlyPart::browserExtension (  )  const

This convenience method returns the browserExtension for this part, or 0 if there isn't any.

Definition at line 690 of file part.cpp.

void KParts::ReadOnlyPart::canceled ( const QString &  errMsg  )  [signal]

Emit this if loading is canceled by the user or by an error.

Parameters:
errMsg the error message, empty if the user canceled the loading voluntarily.

bool ReadOnlyPart::closeStream (  ) 

Terminate the sending of data to the part.

With some data types (text, html...) closeStream might never actually be called, in the case of continuous streams, for instance plain text or HTML data.

Definition at line 685 of file part.cpp.

bool ReadOnlyPart::closeUrl (  )  [virtual]

Called when closing the current url (e.g.

document), for instance when switching to another url (note that openUrl() calls it automatically in this case). If the current URL is not fully loaded yet, aborts loading. Deletes the temporary file used when the url is remote.

Returns:
always true, but the return value exists for reimplementations

Reimplemented in KParts::ReadWritePart.

Definition at line 606 of file part.cpp.

void KParts::ReadOnlyPart::completed ( bool  pendingAction  )  [signal]

Same as the above signal except it indicates whether there is a pending action to be executed on a delay timer.

An example of this is the meta-refresh tags on web pages used to reload/redirect after a certain period of time. This signal is useful if you want to give the user the ability to cancel such pending actions.

pendingAction true if a pending action exists, false otherwise.

void KParts::ReadOnlyPart::completed (  )  [signal]

Emit this when you have completed loading data.

Hosting apps will want to know when the process of loading the data is finished, so that they can access the data when everything is loaded.

void ReadOnlyPart::guiActivateEvent ( GUIActivateEvent *  event  )  [protected, virtual]

Reimplemented from Part, so that the window caption is set to the current url (decoded) when the part is activated This is the usual behavior in 99% of the apps Reimplement if you don't like it - test for event->activated() !

Technical note : this is done with GUIActivateEvent and not with PartActivateEvent because it's handled by the mainwindow (which gets the even after the PartActivateEvent events have been sent)

Reimplemented from KParts::Part.

Definition at line 654 of file part.cpp.

bool ReadOnlyPart::isLocalFileTemporary (  )  const [protected]

Definition at line 490 of file part.cpp.

bool ReadOnlyPart::isProgressInfoEnabled (  )  const

Returns whether the part shows the progress info dialog used by internal KIO job.

Definition at line 511 of file part.cpp.

QString ReadOnlyPart::localFilePath (  )  const [protected]

Returns the local file path associated with this part.

Definition at line 476 of file part.cpp.

virtual bool KParts::ReadOnlyPart::openFile (  )  [protected, pure virtual]

If the part uses the standard implementation of openUrl(), it must reimplement this, to open the local file.

Otherwise simply define it to { return false; }

bool ReadOnlyPart::openStream ( const QString &  mimeType,
const KUrl &  url 
)

Initiate sending data to this part.

This is an alternative to openUrl, which allows the user of the part to load the data itself, and send it progressively to the part.

Parameters:
mimeType the type of data that is going to be sent to this part.
url the URL representing this data. Although not directly used, every ReadOnlyPart has a URL (see url()), so this simply sets it.
Returns:
true if the part supports progressive loading and accepts data, false otherwise.

Definition at line 668 of file part.cpp.

bool ReadOnlyPart::openUrl ( const KUrl &  url  )  [virtual, slot]

Only reimplement openUrl if you don't want the network transparency support to download from the url into a temporary file (when the url isn't local).

Otherwise, reimplement openFile() only .

If you reimplement it, don't forget to set the caption, usually with emit setWindowCaption( url.prettyUrl() );

Definition at line 527 of file part.cpp.

void KParts::ReadOnlyPart::setArguments ( const OpenUrlArguments &  arguments  ) 

Sets the arguments to use for the next openUrl call.

Definition at line 695 of file part.cpp.

void ReadOnlyPart::setLocalFilePath ( const QString &  localFilePath  )  [protected]

Sets the local file path associated with this part.

Definition at line 483 of file part.cpp.

void ReadOnlyPart::setLocalFileTemporary ( bool  temp  )  [protected]

Definition at line 497 of file part.cpp.

void ReadOnlyPart::setProgressInfoEnabled ( bool  show  ) 

Call this to turn off the progress info dialog used by the internal KIO job.

Use this if you provide another way of displaying progress info (e.g. a statusbar), using the signals emitted by this class, and/or those emitted by the Job given by started.

Definition at line 504 of file part.cpp.

void ReadOnlyPart::setUrl ( const KUrl &  url  )  [protected]

Sets the url associated with this part.

Definition at line 469 of file part.cpp.

void ReadOnlyPart::showProgressInfo ( bool  show  ) 

Definition at line 519 of file part.cpp.

void KParts::ReadOnlyPart::started ( KIO::Job *   )  [signal]

The part emits this when starting data.

If using a KIO::Job, it sets the job in the signal, so that progress information can be shown. Otherwise, job is 0.

KUrl KParts::ReadOnlyPart::url (  )  const

Returns the URL currently opened in this part.

Returns:
The current URL.

bool ReadOnlyPart::writeStream ( const QByteArray &  data  ) 

Send some data to the part.

openStream must have been called previously, and must have returned true.

Returns:
true if the data was accepted by the part. If false is returned, the application should stop sending data, and doesn't have to call closeStream.

Definition at line 680 of file part.cpp.


Property Documentation

KUrl ReadOnlyPart::url [read]

Definition at line 492 of file part.h.


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
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
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