class ReadOnlyPart

Public Methods

•  ReadOnlyPart ( QObject *parent = 0, const char *name = 0 )
• virtual  ~ReadOnlyPart ()
• void  showProgressInfo ( bool show )
• virtual const KURL &  url () const
• virtual bool  closeURL ()

Public Slots

• virtual bool  openURL ( const KURL &url )

Signals

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

Protected Methods

• virtual bool  openFile ()
• void  abortLoad ()
• virtual void  guiActivateEvent ( GUIActivateEvent *event )

Protected Slots

• void  slotJobFinished ( KIO::Job * job )

Protected Members

• KURL m_url
• QString m_file
• bool m_bTemp

Detailed Description

Base class for any "viewer" part.

This class takes care of network transparency for you, in the simplest way (synchronously). To use the built-in network transparency, you only need to implement openFile(), not openURL(). To prevent network transparency, or to implement it another way (e.g. asynchronously), 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()

Constructor See also Part for the setXXX methods to call.

[virtual]

Destructor

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.

[virtual slot]

Only reimplement openURL if you don't want synchronous network transparency Otherwise, reimplement openFile() only .

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

[const virtual]

Retrieves the currently in part used URL.

Returns: The current used URL.

[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

[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.

[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.

[signal]

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

[protected slots: slot]

[protected: pure virtual]

If the part uses the standard implementation of openURL(), it must reimplement this, to open m_file. Otherwise simply define it to { return false; }

[protected: ]

[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 behaviour 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 Part.

[protected: ]

[protected: ]

[protected: ]