KPIM Namespace Reference

Classes
class	SelectionItem
class	BroadcastStatus
class	ClickLineEdit
class	CollectingProcess
class	ConfigManager
class	DiffAlgoDisplay
class	DistributionList
class	KMailCompletion
class	KPixmapRegionSelectorDialog
class	KPixmapRegionSelectorWidget
class	LdapObject
class	LdapClient
struct	LdapResult
class	LdapSearch
class	OverlayWidget
class	PluginLoader
class	ProgressManager
class	ResourceABC

Typedefs
typedef TQValueList< LdapResult >	LdapResultList
typedef TQMap< TQString, TQPair< int, int > >	CompletionItemsMap
typedef TQValueList< TQByteArray >	LdapAttrValue
typedef TQMap< TQString, LdapAttrValue >	LdapAttrMap
typedef TQValueList< MailSummary >	MailList
typedef TQMap< ProgressItem *, bool >	ProgressItemMap

Functions
static void	swapItems (CompletionViewItem *one, CompletionViewItem *other)
static void	msgDialog (const TQString &msg)
TDE_EXPORT TQCString	kFileToString (const TQString &fileName, bool ensureNewline=true, bool withDialogs=true) TDE_EXPORT
TDE_EXPORT bool	kBytesToFile (const char *aBuffer, int len, const TQString &aFileName, bool aAskIfExists, bool aBackup, bool aVerbose) TDE_EXPORT
TDE_EXPORT bool	kCStringToFile (const TQCString &aBuffer, const TQString &aFileName, bool aAskIfExists, bool aBackup, bool aVerbose)
TDE_EXPORT bool	kByteArrayToFile (const TQByteArray &buffer, const TQString &fileName, bool askIfExists=false, bool createBackup=true, bool withDialogs=true) TDE_EXPORT
TQString	checkAndCorrectPermissionsIfPossible (const TQString &toCheck, const bool recursive, const bool wantItReadable, const bool wantItWritable)
bool	checkAndCorrectPermissionsIfPossibleWithErrorHandling (TQWidget *parent, const TQString &toCheck, const bool recursive, const bool wantItReadable, const bool wantItWritable)

Variables
static const char *const	quoteFontSizes [] = { "85", "80", "75" }
static KStaticDeleter< ProgressManager >	progressManagerDeleter

Detailed Description

TDEPIM classes for drag and drop of mails.

// Code example for drag and drop enabled widget

void SomeWidget::contentsDropEvent(TQDropEvent *e) { if (e->provides(MailListDrag::format())) { MailList mailList; MailListDrag::decode( e, mailList ); ...

Function Documentation

checkAndCorrectPermissionsIfPossible()

TQString KPIM::checkAndCorrectPermissionsIfPossible	(	const TQString &	toCheck,
		const bool	recursive,
		const bool	wantItReadable,
		const bool	wantItWritable
	)

Checks and corrects the permissions of a file or folder, and if requested all files and folders below.

It gives back a list of files which do not have the right permissions. This list can be used to show to the user.

Parameters

toCheck	The file or folder of which the permissions should be checked.
recursive	Set to true, it will check the contents of a folder for the permissions recursively. If false only toCheck will be checked.
wantItReadable	Set to true, it will check for read permissions. If the read permissions are not available, there will be a attempt to correct this.
wantItWritable	Set to true, it will check for write permissions. If the write permissions are not available, there will be a attempt to correct this.

Returns

It will return a string with all files and folders which do not have the right permissions. If empty, then all permissions are ok.

Definition at line 271 of file tdefileio.cpp.

checkAndCorrectPermissionsIfPossibleWithErrorHandling()

bool KPIM::checkAndCorrectPermissionsIfPossibleWithErrorHandling	(	TQWidget *	parent,
		const TQString &	toCheck,
		const bool	recursive,
		const bool	wantItReadable,
		const bool	wantItWritable
	)

Checks and corrects the permissions of a file or folder, and if requested all files and folders below.

If the permissions are not ok, it tries to correct them. If that fails then a warning with detailled information is given.

Parameters

parent	If parent is 0, then the message box becomes an application-global modal dialog box. If parent is a widget, the message box becomes modal relative to parent.
toCheck	The file or folder of which the permissions should be checked.
recursive	Set to true, it will check the contents of a folder for the permissions recursively. If false only toCheck will be checked.
wantItReadable	Set to true, it will check for read permissions. If the read permissions are not available, there will be a attempt to correct this.
wantItWritable	Set to true, it will check for write permissions. If the write permissions are not available, there will be a attempt to correct this.

Returns

It will return true if all permissions in the end are ok. If false then the permissions are not ok and it was not possible to correct all errors.

Definition at line 368 of file tdefileio.cpp.

kByteArrayToFile()

bool KPIM::kByteArrayToFile	(	const TQByteArray &	aBuffer,
		const TQString &	aFileName,
		bool	aAskIfExists,
		bool	aBackup,
		bool	aVerbose
	)

Does not stop at NUL.

Definition at line 263 of file tdefileio.cpp.

kBytesToFile()

bool KPIM::kBytesToFile	(	const char *	aBuffer,
		int	len,
		const TQString &	aFileName,
		bool	aAskIfExists,
		bool	aBackup,
		bool	aVerbose
	)

Save a file.

If withDialogs is FALSE no warning dialogs are opened if there are problems. Returns TRUE on success and FALSE on failure. Replaces existing files without warning if askIfExists==FALSE. Makes a copy if the file exists to filename~ if createBackup==TRUE.

Definition at line 176 of file tdefileio.cpp.

kFileToString()

TQCString KPIM::kFileToString	(	const TQString &	fileName,
		bool	ensureNewline = true,
		bool	withDialogs = true
	)

Load a file.

Returns a pointer to the memory-block that contains the loaded file. Returns a null string if the file could not be loaded. If withDialogs is FALSE no warning dialogs are opened if there are problems. The string returned is always zero-terminated and therefore one byte longer than the file itself. If ensureNewline is TRUE the string will always have a trailing newline.

Definition at line 36 of file tdefileio.cpp.