KMail::FolderDiaTab Class Reference

#include <kmfolderdia.h>

Inheritance diagram for KMail::FolderDiaTab:

Public Types
enum	AccepStatus { Accepted , Canceled , Delayed }

Signals
void	readyForAccept ()
void	cancelAccept ()
void	changed (bool)

Public Member Functions
	FolderDiaTab (TQWidget *parent=0, const char *name=0)
virtual void	load ()=0
virtual bool	save ()=0
virtual AccepStatus	accept ()

Detailed Description

This is the base class for tabs in the folder dialog.

It uses the API from ConfigModuleTab (basically: it's a widget that can load and save) but it also adds support for delayed-saving: when save() needs to use async jobs (e.g. TDEIO) for saving, we need to delay the closing until after the jobs are finished, and to cancel the saving on error.

Feel free to rename and move this base class somewhere else if it can be useful for other dialogs.

Definition at line 69 of file kmfolderdia.h.

Member Function Documentation

accept()

virtual AccepStatus KMail::FolderDiaTab::accept ( )

inlinevirtual

Called when clicking OK.

If a module returns Delayed, the closing is cancelled for now, and the module can close the dialog later on (i.e. after an async operation like a TDEIO job).

Reimplemented in KMail::FolderDiaQuotaTab, and KMail::FolderDiaACLTab.

Definition at line 90 of file kmfolderdia.h.

cancelAccept

void KMail::FolderDiaTab::cancelAccept ( )

signal

Emit this, i.e.

after a job had an error, to tell the dialog to cancel the closing.

changed

void KMail::FolderDiaTab::changed ( bool  )

signal

Called when this module was changed [not really used yet].

readyForAccept

void KMail::FolderDiaTab::readyForAccept ( )

signal

Emit this to tell the dialog that you're done with the async jobs, and that the dialog can be closed.

save()

virtual bool KMail::FolderDiaTab::save ( )

pure virtual

Unlike ConfigModuleTab, we return a bool from save.

This allows to cancel closing on error. When called from the Apply button, the return value is ignored

Returns

whether save succeeded

Implemented in KMail::FolderDiaTemplatesTab, KMail::FolderDiaGeneralTab, KMail::FolderDiaQuotaTab, and KMail::FolderDiaACLTab.

---

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

• kmfolderdia.h