#include <KoTemplateChooseDia.h>

Inheritance diagram for KoTemplateChooseDia:

Public Types
enum	ReturnType { Cancel , Template , File , Empty }
enum	DialogType { Everything , OnlyTemplates , NoTemplates }
Public Types inherited from KDialogBase
enum	ButtonCode
enum	DialogType

Public Member Functions
TQString	getTemplate () const
TQString	getFullTemplate () const
ReturnType	getReturnType () const
DialogType	getDialogType () const
Public Member Functions inherited from KDialogBase
	KDialogBase (TQWidget parent=0, const char name=0, bool modal=true, const TQString &caption=TQString::null, int buttonMask=Ok\|Apply\|Cancel, ButtonCode defaultButton=Ok, bool separator=false, const KGuiItem &user1=KGuiItem(), const KGuiItem &user2=KGuiItem(), const KGuiItem &user3=KGuiItem())
	KDialogBase (int dialogFace, const TQString &caption, int buttonMask, ButtonCode defaultButton, TQWidget parent=0, const char name=0, bool modal=true, bool separator=false, const KGuiItem &user1=KGuiItem(), const KGuiItem &user2=KGuiItem(), const KGuiItem &user3=KGuiItem())
	KDialogBase (KDialogBase::DialogType dialogFace, WFlags f, TQWidget parent=0, const char name=0, bool modal=true, const TQString &caption=TQString::null, int buttonMask=Ok\|Apply\|Cancel, ButtonCode defaultButton=Ok, bool separator=false, const KGuiItem &user1=KGuiItem(), const KGuiItem &user2=KGuiItem(), const KGuiItem &user3=KGuiItem())
	KDialogBase (const TQString &caption, int buttonMask=Yes\|No\|Cancel, ButtonCode defaultButton=Yes, ButtonCode escapeButton=Cancel, TQWidget parent=0, const char name=0, bool modal=true, bool separator=false, const KGuiItem &yes=KStdGuiItem::yes(), const KGuiItem &no=KStdGuiItem::no(), const KGuiItem &cancel=KStdGuiItem::cancel())
void	setButtonBoxOrientation (int orientation)
void	setEscapeButton (ButtonCode id)
virtual void	adjustSize ()
TQFrame *	plainPage ()
TQFrame *	addPage (const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQFrame *	addPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQVBox *	addVBoxPage (const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQVBox *	addVBoxPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQHBox *	addHBoxPage (const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQHBox *	addHBoxPage (const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQGrid *	addGridPage (int n, Orientation dir, const TQString &itemName, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
TQGrid *	addGridPage (int n, Orientation dir, const TQStringList &items, const TQString &header=TQString::null, const TQPixmap &pixmap=TQPixmap())
void	setFolderIcon (const TQStringList &path, const TQPixmap &pixmap)
TQFrame *	makeMainWidget ()
TQVBox *	makeVBoxMainWidget ()
TQHBox *	makeHBoxMainWidget ()
TQGrid *	makeGridMainWidget (int n, Orientation dir)
void	enableButtonSeparator (bool state)
void	showButton (ButtonCode id, bool state)
void	showButtonOK (bool state)
void	showButtonApply (bool state)
void	showButtonCancel (bool state)
bool	showPage (int index)
int	activePageIndex () const
int	pageIndex (TQWidget *widget) const
void	setMainWidget (TQWidget *widget)
TQWidget *	mainWidget ()
void	disableResize ()
void	setInitialSize (const TQSize &s, bool noResize=false)
void	incInitialSize (const TQSize &s, bool noResize=false)
TQSize	configDialogSize (const TQString &groupName) const
TQSize	configDialogSize (TDEConfig &config, const TQString &groupName) const
void	saveDialogSize (const TQString &groupName, bool global=false)
void	saveDialogSize (TDEConfig &config, const TQString &groupName, bool global=false) const
void	setButtonOK (const KGuiItem &item=KStdGuiItem::ok())
void	setButtonOKText (const TQString &text=TQString::null, const TQString &tooltip=TQString::null, const TQString &quickhelp=TQString::null) TDE_DEPRECATED
void	setButtonApply (const KGuiItem &item=KStdGuiItem::apply())
void	setButtonApplyText (const TQString &text=TQString::null, const TQString &tooltip=TQString::null, const TQString &quickhelp=TQString::null) TDE_DEPRECATED
void	setButtonCancel (const KGuiItem &item=KStdGuiItem::cancel())
void	setButtonCancelText (const TQString &text=TQString::null, const TQString &tooltip=TQString::null, const TQString &quickhelp=TQString::null) TDE_DEPRECATED
void	setButtonText (ButtonCode id, const TQString &text)
void	setButtonTip (ButtonCode id, const TQString &text)
void	setButtonWhatsThis (ButtonCode id, const TQString &text)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setTreeListAutoResize (bool state)
void	setShowIconsInTreeList (bool state)
void	setRootIsDecorated (bool state)
void	unfoldTreeList (bool persist=false)
void	addWidgetBelowList (TQWidget *widget)
void	addButtonBelowList (const TQString &text, TQObject recv, const char slot)
void	addButtonBelowList (const KGuiItem &guiitem, TQObject recv, const char slot)
void	setIconListAllVisible (bool state)
void	showTile (bool state)
void	getBorderWidths (int &ulx, int &uly, int &lrx, int &lry) const TDE_DEPRECATED
TQRect	getContentsRect () const TDE_DEPRECATED
TQSize	calculateSize (int w, int h) const
TQString	helpLinkText () const
TQPushButton *	actionButton (ButtonCode id)
Public Member Functions inherited from KDialog
	KDialog (TQWidget parent=0, const char name=0, bool modal=false, WFlags f=0)

Static Public Member Functions
static ReturnType	choose (TDEInstance instance, TQString &file, const DialogType &dialogType, const TQCString &templateType, TQWidget parent)
Static Public Member Functions inherited from KDialogBase
static bool	haveBackgroundTile ()
static const TQPixmap *	backgroundTile ()
static const TQPixmap *	getBackgroundTile () TDE_DEPRECATED
static void	setBackgroundTile (const TQPixmap *pix)
Static Public Member Functions inherited from KDialog
static int	marginHint ()
static int	spacingHint ()
static void	resizeLayout (TQWidget *widget, int margin, int spacing)
static void	resizeLayout (TQLayoutItem *lay, int margin, int spacing)
static void	centerOnScreen (TQWidget *widget, int screen=-1)
static bool	avoidArea (TQWidget *widget, const TQRect &area, int screen=-1)

Protected Slots
virtual void	slotOk ()
Protected Slots inherited from KDialogBase
virtual void	slotHelp ()
virtual void	slotDefault ()
virtual void	slotDetails ()
virtual void	slotUser3 ()
virtual void	slotUser2 ()
virtual void	slotUser1 ()
virtual void	slotOk ()
virtual void	slotApply ()
virtual void	slotTry ()
virtual void	slotYes ()
virtual void	slotNo ()
virtual void	slotCancel ()
virtual void	slotClose ()
virtual void	applyPressed ()
void	updateGeometry ()
void	slotDelayedDestruct ()

Additional Inherited Members
Public Slots inherited from KDialogBase
void	enableButton (ButtonCode id, bool state)
void	enableButtonOK (bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableLinkedHelp (bool state)
void	delayedDestruct ()
void	setHelpLinkText (const TQString &text)
void	setHelp (const TQString &anchor, const TQString &appname=TQString::null)
void	helpClickedSlot (const TQString &)
void	setDetails (bool showDetails)
void	setDetailsWidget (TQWidget *detailsWidget)
void	updateBackground ()
void	cancel ()
Public Slots inherited from KDialog
virtual void	polish ()
virtual void	setCaption (const TQString &caption)
virtual void	setPlainCaption (const TQString &caption)
Signals inherited from KDialogBase
void	helpClicked ()
void	defaultClicked ()
void	user3Clicked ()
void	user2Clicked ()
void	user1Clicked ()
void	applyClicked ()
void	tryClicked ()
void	okClicked ()
void	yesClicked ()
void	noClicked ()
void	cancelClicked ()
void	closeClicked ()
void	apply ()
void	backgroundChanged ()
void	hidden ()
void	finished ()
void	aboutToShowDetails ()
void	aboutToShowPage (TQWidget *page)
Signals inherited from KDialog
void	layoutHintChanged ()
Public Attributes inherited from KDialogBase
	Help
	Default
	Ok
	Apply
	Try
	Cancel
	Close
	User1
	User2
	User3
	No
	Yes
	Details
	Filler
	Stretch
	NoDefault
Protected Member Functions inherited from KDialogBase
virtual void	keyPressEvent (TQKeyEvent *e)
virtual void	hideEvent (TQHideEvent *)
virtual void	closeEvent (TQCloseEvent *e)

Detailed Description

This class is used to show the template dialog on startup.

Unless you need something special, you should use the static method choose().

The template choose dialog

Author: Reginald Stadlbauer reggi.nosp@m.e@kd.nosp@m.e.org; Werner Trobin trobi.nosp@m.n@kd.nosp@m.e.org

Definition at line 133 of file KoTemplateChooseDia.h.

Member Enumeration Documentation

◆ DialogType

enum KoTemplateChooseDia::DialogType

To configure the dialog you have to use this enum.

Everything = Show templates and the rest of the dialog OnlyTemplates = Show only the templates NoTemplates = Just guess :)

Definition at line 154 of file KoTemplateChooseDia.h.

◆ ReturnType

enum KoTemplateChooseDia::ReturnType

The Dialog returns one of these values depending on the input of the user.

Cancel = The user pressed 'Cancel' Template = The user selected a template File = The user has chosen a file Empty = The user selected "Empty document"

Definition at line 147 of file KoTemplateChooseDia.h.

Constructor & Destructor Documentation

◆ ~KoTemplateChooseDia()

KoTemplateChooseDia::~KoTemplateChooseDia ( )

Definition at line 215 of file KoTemplateChooseDia.cpp.

Member Function Documentation

◆ choose()

KoTemplateChooseDia::ReturnType KoTemplateChooseDia::choose	(	TDEInstance *	instance,
		TQString &	file,
		const DialogType &	dialogType,
		const TQCString &	templateType,
		TQWidget *	parent )

static

This is the static method you'll normally use to show the dialog.

Parameters

instance	the TDEInstance of your app The native mimetype is retrieved from the (desktop file of) that instance.
file	this is the filename which is returned to your app More precisely, it's a url (to give to KURL) if ReturnType is File and it's a path (to open directly) if ReturnType is Template
dialogType	the type of the dialog
templateType	the template type of your application (see kword or kpresenter for details)
parent	pointer to parent widget

Returns: The return type (see above)

Definition at line 229 of file KoTemplateChooseDia.cpp.

◆ getDialogType()

KoTemplateChooseDia::DialogType KoTemplateChooseDia::getDialogType ( ) const

The dialogType - normally you won't need this one.

Definition at line 294 of file KoTemplateChooseDia.cpp.

◆ getFullTemplate()

TQString KoTemplateChooseDia::getFullTemplate ( ) const

Method to get the "full" template (path+template).

Definition at line 286 of file KoTemplateChooseDia.cpp.

◆ getReturnType()

KoTemplateChooseDia::ReturnType KoTemplateChooseDia::getReturnType ( ) const

The ReturnType (call this one after exec()).

Definition at line 290 of file KoTemplateChooseDia.cpp.

◆ getTemplate()

TQString KoTemplateChooseDia::getTemplate ( ) const

Method to get the current template.

Definition at line 282 of file KoTemplateChooseDia.cpp.

◆ slotOk

void KoTemplateChooseDia::slotOk ( void )

protectedvirtualslot

Activated when the Ok button has been clicked.

Definition at line 634 of file KoTemplateChooseDia.cpp.

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

lib

Public Types

Public Member Functions

Static Public Member Functions

Protected Slots

Additional Inherited Members