KParts::ReadWritePart Class Reference

#include <part.h>

Inheritance diagram for KParts::ReadWritePart:

Public Slots
virtual bool	save ()
void	setModified ()
bool	waitSaveComplete ()
Public Slots inherited from KParts::ReadOnlyPart
virtual bool	openUrl (const KUrl &url)

Signals
void	sigQueryClose (bool *handled, bool *abortClosing)
Signals inherited from KParts::ReadOnlyPart
void	canceled (const QString &errMsg)
void	completed ()
void	completed (bool pendingAction)
void	started (KIO::Job *)
void	urlChanged (const KUrl &url)
Signals inherited from KParts::Part
void	setStatusBarText (const QString &text)
void	setWindowCaption (const QString &caption)

Public Member Functions
	ReadWritePart (QObject *parent=0)
virtual	~ReadWritePart ()
virtual bool	closeUrl ()
virtual bool	closeUrl (bool promptToSave)
bool	isModified () const
bool	isReadWrite () const
virtual bool	queryClose ()
virtual bool	saveAs (const KUrl &url)
virtual void	setModified (bool modified)
virtual void	setReadWrite (bool readwrite=true)
Public Member Functions inherited from KParts::ReadOnlyPart
	ReadOnlyPart (QObject *parent=0)
virtual	~ReadOnlyPart ()
OpenUrlArguments	arguments () const
BrowserExtension *	browserExtension () const
bool	closeStream ()
bool	isProgressInfoEnabled () const
bool	openStream (const QString &mimeType, const KUrl &url)
void	setArguments (const OpenUrlArguments &arguments)
void	setProgressInfoEnabled (bool show)
void	showProgressInfo (bool show)
KUrl	url () const
bool	writeStream (const QByteArray &data)
Public Member Functions inherited from KParts::Part
	Part (QObject *parent=0)
virtual	~Part ()
virtual void	embed (QWidget *parentWidget)
virtual Part *	hitTest (QWidget *widget, const QPoint &globalPos)
KIconLoader *	iconLoader ()
bool	isSelectable () const
PartManager *	manager () const
void	setAutoDeletePart (bool autoDeletePart)
void	setAutoDeleteWidget (bool autoDeleteWidget)
virtual void	setManager (PartManager *manager)
virtual void	setSelectable (bool selectable)
virtual QWidget *	widget ()
Public Member Functions inherited from KParts::PartBase
	PartBase ()
virtual	~PartBase ()
QObject *	partObject () const
void	setPartObject (QObject *object)
Public Member Functions inherited from KXMLGUIClient
	KXMLGUIClient ()
	KXMLGUIClient (KXMLGUIClient *parent)
virtual	~KXMLGUIClient ()
QAction *	action (const char *name) const
virtual QAction *	action (const QDomElement &element) const
virtual KActionCollection *	actionCollection () const
void	addStateActionDisabled (const QString &state, const QString &action)
void	addStateActionEnabled (const QString &state, const QString &action)
void	beginXMLPlug (QWidget *)
QList< KXMLGUIClient * >	childClients ()
KXMLGUIBuilder *	clientBuilder () const
virtual KComponentData	componentData () const
virtual QDomDocument	domDocument () const
void	endXMLPlug ()
KXMLGUIFactory *	factory () const
StateChange	getActionsToChangeForState (const QString &state)
void	insertChildClient (KXMLGUIClient *child)
virtual QString	localXMLFile () const
KXMLGUIClient *	parentClient () const
void	plugActionList (const QString &name, const QList< QAction * > &actionList)
void	prepareXMLUnplug (QWidget *)
void	reloadXML ()
void	removeChildClient (KXMLGUIClient *child)
void	replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)
void	setClientBuilder (KXMLGUIBuilder *builder)
void	setFactory (KXMLGUIFactory *factory)
void	setXMLGUIBuildDocument (const QDomDocument &doc)
void	unplugActionList (const QString &name)
virtual QString	xmlFile () const
QDomDocument	xmlguiBuildDocument () const

Protected Member Functions
virtual bool	saveFile ()=0
virtual bool	saveToUrl ()
Protected Member Functions inherited from KParts::ReadOnlyPart
	ReadOnlyPart (ReadOnlyPartPrivate &dd, QObject *parent)
void	abortLoad ()
virtual void	guiActivateEvent (GUIActivateEvent *event)
bool	isLocalFileTemporary () const
QString	localFilePath () const
virtual bool	openFile ()
void	setLocalFilePath (const QString &localFilePath)
void	setLocalFileTemporary (bool temp)
void	setUrl (const KUrl &url)
Protected Member Functions inherited from KParts::Part
	Part (PartPrivate &dd, QObject *parent)
virtual void	customEvent (QEvent *event)
QWidget *	hostContainer (const QString &containerName)
void	loadPlugins ()
virtual void	partActivateEvent (PartActivateEvent *event)
virtual void	partSelectEvent (PartSelectEvent *event)
virtual void	setWidget (QWidget *widget)
Protected Member Functions inherited from KParts::PartBase
	PartBase (PartBasePrivate &dd)
void	loadPlugins (QObject *parent, KXMLGUIClient *parentGUIClient, const KComponentData &componentData)
virtual void	setComponentData (const KComponentData &componentData)
virtual void	setComponentData (const KComponentData &componentData, bool loadPlugins)
void	setPluginInterfaceVersion (int version)
void	setPluginLoadingMode (PluginLoadingMode loadingMode)
Protected Member Functions inherited from KXMLGUIClient
void	loadStandardsXmlFile ()
virtual void	setDOMDocument (const QDomDocument &document, bool merge=false)
virtual void	setLocalXMLFile (const QString &file)
virtual void	setXML (const QString &document, bool merge=false)
virtual void	setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true)
virtual void	stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse)
virtual void	virtual_hook (int id, void *data)

Additional Inherited Members
Public Types inherited from KXMLGUIClient
enum	ReverseStateChange
Static Public Member Functions inherited from KXMLGUIClient
static QString	findMostRecentXMLFile (const QStringList &files, QString &doc)
Protected Types inherited from KParts::PartBase
enum	PluginLoadingMode { DoNotLoadPlugins = 0, LoadPlugins = 1, LoadPluginsIfEnabled = 2 }
Protected Slots inherited from KParts::Part
void	slotWidgetDestroyed ()
Protected Attributes inherited from KParts::PartBase
PartBasePrivate *	d_ptr
Properties inherited from KParts::ReadOnlyPart
KUrl	url

Detailed Description

Base class for an "editor" part.

This class handles network transparency for you. Anything that can open a URL, allow modifications, and save (to the same URL or a different one).

A read-write part can be set to read-only mode, using setReadWrite().

Part writers : Any part inheriting ReadWritePart should check isReadWrite before allowing any action that modifies the part. The part probably wants to reimplement setReadWrite, disable those actions. Don't forget to call the parent setReadWrite.

Definition at line 745 of file part.h.

Constructor & Destructor Documentation

ReadWritePart::ReadWritePart ( QObject *  parent = 0 )

explicit

Constructor See parent constructor for instructions.

Definition at line 769 of file part.cpp.

ReadWritePart::~ReadWritePart ( )

virtual

Destructor Applications using a ReadWritePart should make sure, before destroying it, to call closeUrl().

In KMainWindow::queryClose(), for instance, they should allow closing only if the return value of closeUrl() was true. This allows to cancel.

Definition at line 774 of file part.cpp.

Member Function Documentation

bool ReadWritePart::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.

If isModified(), queryClose() will be called.

Returns

false on cancel

Reimplemented from KParts::ReadOnlyPart.

Definition at line 855 of file part.cpp.

bool ReadWritePart::closeUrl ( bool  promptToSave )

virtual

Call this method instead of the above if you need control if the save prompt is shown.

For example, if you call queryClose() from KMainWindow::queryClose(), you would not want to prompt again when closing the url.

Equivalent to promptToSave ? closeUrl() : ReadOnlyPart::closeUrl()

Definition at line 867 of file part.cpp.

bool ReadWritePart::isModified

(

)

const

Returns

true if the document has been modified.

Definition at line 1027 of file part.cpp.

bool ReadWritePart::isReadWrite

(

)

const

Returns

true if the part is in read-write mode

Definition at line 1020 of file part.cpp.

bool ReadWritePart::queryClose ( )

virtual

If the document has been modified, ask the user to save changes.

This method is meant to be called from KMainWindow::queryClose(). It will also be called from closeUrl().

Returns

true if closeUrl() can be called without the user losing important data, false if the user chooses to cancel.

Definition at line 808 of file part.cpp.

bool ReadWritePart::save ( )

virtualslot

Save the file in the location from which it was opened.

You can connect this to the "save" action. Calls saveFile() and saveToUrl(), no need to reimplement.

Definition at line 872 of file part.cpp.

bool ReadWritePart::saveAs ( const KUrl &  url )

virtual

Save the file to a new location.

Calls save(), no need to reimplement

Definition at line 886 of file part.cpp.

virtual bool KParts::ReadWritePart::saveFile ( )

protectedpure virtual

Save to a local file.

You need to implement it, to save to the local file. The framework takes care of re-uploading afterwards.

Returns

true on success, false on failure. On failure the function should inform the user about the problem with an appropriate message box. Standard error messages can be constructed using KIO::buildErrorString() in combination with the error codes defined in kio/global.h

bool ReadWritePart::saveToUrl ( )

protectedvirtual

Save the file.

Uploads the file, if url is remote. This will emit started(), and either completed() or canceled(), in case you want to provide feedback.

Returns

true on success, false on failure.

Definition at line 943 of file part.cpp.

void ReadWritePart::setModified ( bool  modified )

virtual

Sets the modified flag of the part.

Definition at line 790 of file part.cpp.

void ReadWritePart::setModified ( )

slot

Call setModified() whenever the contents get modified.

This is a slot for convenience, since it simply calls setModified(true), so that you can connect it to a signal, like textChanged().

Definition at line 803 of file part.cpp.

void ReadWritePart::setReadWrite ( bool  readwrite = true )

virtual

Changes the behavior of this part to readonly or readwrite.

Parameters

readwrite

set to true to enable readwrite mode

Definition at line 782 of file part.cpp.

void KParts::ReadWritePart::sigQueryClose ( bool *  handled, bool *  abortClosing  )

signal

set handled to true, if you don't want the default handling set abortClosing to true, if you handled the request, but for any reason don't want to allow closing the document

bool ReadWritePart::waitSaveComplete ( )

slot

Waits for any pending upload job to finish and returns whether the last save() action was successful.

Definition at line 1034 of file part.cpp.

---

The documentation for this class was generated from the following files:

• part.h
• part.cpp