KEncodingFileDialog Class Reference

Provides a user (and developer) friendly way to select files with support for choosing encoding. More...

#include <kencodingfiledialog.h>

Inheritance diagram for KEncodingFileDialog:

[legend]

List of all members.

Classes
class	Result
Public Member Functions
	KEncodingFileDialog (const QString &startDir=QString::null, const QString &encoding=QString::null, const QString &filter=QString::null, const QString &caption=QString::null, KFileDialog::OperationMode type=KFileDialog::Opening, QWidget *parent=0, const char *name="", bool modal=true)
QString	selectedEncoding () const
	~KEncodingFileDialog ()
Static Public Member Functions
static Result	getOpenFileNameAndEncoding (const QString &encoding=QString::null, const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null)
static Result	getOpenFileNamesAndEncoding (const QString &encoding=QString::null, const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null)
static Result	getOpenURLAndEncoding (const QString &encoding=QString::null, const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null)
static Result	getOpenURLsAndEncoding (const QString &encoding=QString::null, const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null)
static Result	getSaveFileNameAndEncoding (const QString &encoding=QString::null, const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null)
static Result	getSaveURLAndEncoding (const QString &encoding=QString::null, const QString &startDir=QString::null, const QString &filter=QString::null, QWidget *parent=0, const QString &caption=QString::null)
Protected Member Functions
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

Provides a user (and developer) friendly way to select files with support for choosing encoding.

The dialog has been designed to allow applications to customise it by subclassing. It uses geometry management to ensure that subclasses can easily add children that will be incorporated into the layout.

Definition at line 39 of file kencodingfiledialog.h.

---

Constructor & Destructor Documentation

KEncodingFileDialog::KEncodingFileDialog	(	const QString &	startDir = QString::null,
		const QString &	encoding = QString::null,
		const QString &	filter = QString::null,
		const QString &	caption = QString::null,
		KFileDialog::OperationMode	type = KFileDialog::Opening,
		QWidget *	parent = 0,
		const char *	name = "",
		bool	modal = true
	)

Constructs a file dialog for text files with encoding selection possibility.

Parameters:

	startDir	This can either be The URL of the directory to start in. QString::null to start in the current working directory, or the last directory where a file has been selected. ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword. '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
	encoding	The encoding shown in the encoding combo. If it's QString::null, the global default encoding will be shown.
	filter	This is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
	caption	The caption of the dialog
	type	This can either be Opening (open dialog, the default setting) Saving
	parent	The parent widget of this dialog
	name	The name of this object
	modal	Whether to create a modal dialog or not

Since:

3.2

Definition at line 39 of file kencodingfiledialog.cpp.

KEncodingFileDialog::~KEncodingFileDialog

(

)

Destructs the file dialog.

Definition at line 81 of file kencodingfiledialog.cpp.

---

Member Function Documentation

KEncodingFileDialog::Result KEncodingFileDialog::getOpenFileNameAndEncoding	(	const QString &	encoding = QString::null,
		const QString &	startDir = QString::null,
		const QString &	filter = QString::null,
		QWidget *	parent = 0,
		const QString &	caption = QString::null
	)			[static]

Creates a modal file dialog and return the selected filename or an empty string if none was chosen additionally a chosen encoding value is returned.

Note that with this method the user must select an existing filename.

Parameters:

	startDir	This can either be The URL of the directory to start in. QString::null to start in the current working directory, or the last directory where a file has been selected. ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword. '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
	encoding	The encoding shown in the encoding combo.
	filter	This is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
	parent	The widget the dialog will be centered on initially.
	caption	The name of the dialog widget.

Definition at line 96 of file kencodingfiledialog.cpp.

KEncodingFileDialog::Result KEncodingFileDialog::getOpenFileNamesAndEncoding	(	const QString &	encoding = QString::null,
		const QString &	startDir = QString::null,
		const QString &	filter = QString::null,
		QWidget *	parent = 0,
		const QString &	caption = QString::null
	)			[static]

Creates a modal file dialog and returns the selected encoding and the selected filenames or an empty list if none was chosen.

Note that with this method the user must select an existing filename.

Parameters:

	startDir	This can either be The URL of the directory to start in. QString::null to start in the current working directory, or the last directory where a file has been selected. ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword. '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
	encoding	The encoding shown in the encoding combo.
	filter	This is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this.
	parent	The widget the dialog will be centered on initially.
	caption	The name of the dialog widget.

Definition at line 114 of file kencodingfiledialog.cpp.

KEncodingFileDialog::Result KEncodingFileDialog::getOpenURLAndEncoding	(	const QString &	encoding = QString::null,
		const QString &	startDir = QString::null,
		const QString &	filter = QString::null,
		QWidget *	parent = 0,
		const QString &	caption = QString::null
	)			[static]

Creates a modal file dialog and returns the selected encoding and URL or an empty string if none was chosen.

Note that with this method the user must select an existing URL.

Parameters:

	startDir	This can either be The URL of the directory to start in. QString::null to start in the current working directory, or the last directory where a file has been selected. ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword. '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
	encoding	The encoding shown in the encoding combo.
	filter	This is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
	parent	The widget the dialog will be centered on initially.
	caption	The name of the dialog widget.

Definition at line 132 of file kencodingfiledialog.cpp.

KEncodingFileDialog::Result KEncodingFileDialog::getOpenURLsAndEncoding	(	const QString &	encoding = QString::null,
		const QString &	startDir = QString::null,
		const QString &	filter = QString::null,
		QWidget *	parent = 0,
		const QString &	caption = QString::null
	)			[static]

Creates a modal file dialog and returns the selected encoding URLs or an empty list if none was chosen.

Note that with this method the user must select an existing filename.

Parameters:

	startDir	This can either be The URL of the directory to start in. QString::null to start in the current working directory, or the last directory where a file has been selected. ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword. '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
	encoding	The encoding shown in the encoding combo.
	filter	This is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
	parent	The widget the dialog will be centered on initially.
	caption	The name of the dialog widget.

Definition at line 148 of file kencodingfiledialog.cpp.

KEncodingFileDialog::Result KEncodingFileDialog::getSaveFileNameAndEncoding	(	const QString &	encoding = QString::null,
		const QString &	startDir = QString::null,
		const QString &	filter = QString::null,
		QWidget *	parent = 0,
		const QString &	caption = QString::null
	)			[static]

Creates a modal file dialog and returns the selected encoding and filename or an empty string if none was chosen.

Note that with this method the user need not select an existing filename.

Parameters:

	startDir	This can either be The URL of the directory to start in. a relative path or a filename determining the directory to start in and the file to be selected. QString::null to start in the current working directory, or the last directory where a file has been selected. ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword. '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
	encoding	The encoding shown in the encoding combo.
	filter	This is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
	parent	The widget the dialog will be centered on initially.
	caption	The name of the dialog widget.

Definition at line 167 of file kencodingfiledialog.cpp.

KEncodingFileDialog::Result KEncodingFileDialog::getSaveURLAndEncoding	(	const QString &	encoding = QString::null,
		const QString &	startDir = QString::null,
		const QString &	filter = QString::null,
		QWidget *	parent = 0,
		const QString &	caption = QString::null
	)			[static]

Creates a modal file dialog and returns the selected encoding and filename or an empty string if none was chosen.

Note that with this method the user need not select an existing filename.

Parameters:

	startDir	This can either be The URL of the directory to start in. a relative path or a filename determining the directory to start in and the file to be selected. QString::null to start in the current working directory, or the last directory where a file has been selected. ':<keyword>' to start in the directory last used by a filedialog in the same application that specified the same keyword. '::<keyword>' to start in the directory last used by a filedialog in any application that specified the same keyword.
	encoding	The encoding shown in the encoding combo.
	filter	This is a space separated list of shell globs. You can set the text to be displayed for the glob, and provide multiple globs. See setFilter() for details on how to do this...
	parent	The widget the dialog will be centered on initially.
	caption	The name of the dialog widget.

Definition at line 192 of file kencodingfiledialog.cpp.

QString KEncodingFileDialog::selectedEncoding

(

)

const

Returns:

The selected encoding if the constructor with the encoding parameter was used, otherwise QString::null.

Definition at line 87 of file kencodingfiledialog.cpp.

void KEncodingFileDialog::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KFileDialog.

Definition at line 217 of file kencodingfiledialog.cpp.

---

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

• kencodingfiledialog.h
• kencodingfiledialog.cpp