lib Library API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

KoTemplateChooseDia Class Reference

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

#include <koTemplateChooseDia.h>

List of all members.

Public Types

enum  ReturnType { Cancel, Template, File, Empty }
enum  DialogType { Everything, OnlyTemplates, NoTemplates }

Public Member Functions

QString getTemplate () const
QString getFullTemplate () const
ReturnType getReturnType () const
DialogType getDialogType () const

Static Public Member Functions

static ReturnType choose (KInstance *instance, QString &file, const DialogType &dialogType, const QCString &templateType, QWidget *parent)

Protected Slots

virtual void slotOk ()

Detailed Description

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

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

Author:
Reginald Stadlbauer <reggie@kde.org>

Werner Trobin <trobin@kde.org>

Definition at line 131 of file koTemplateChooseDia.h.

Member Enumeration Documentation

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 144 of file koTemplateChooseDia.h.

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 151 of file koTemplateChooseDia.h.

Member Function Documentation

KoTemplateChooseDia::ReturnType KoTemplateChooseDia::choose (  KInstance *  instance,
QString &  file,
const DialogType &  dialogType,
const QCString &  templateType,
QWidget *  parent
)  [static]
 

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

Parameters:
instance the KInstance 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)
widget pointer to parent widget
Returns:
The return type (see above)

Definition at line 230 of file koTemplateChooseDia.cc.

References KoDocument::readExtraNativeMimeTypes(), and KoDocument::readNativeFormatMimeType().

QString KoTemplateChooseDia::getTemplate (   )  const
 

Method to get the current template.

Definition at line 283 of file koTemplateChooseDia.cc.

QString KoTemplateChooseDia::getFullTemplate (   )  const
 

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

Definition at line 287 of file koTemplateChooseDia.cc.

KoTemplateChooseDia::ReturnType KoTemplateChooseDia::getReturnType (   )  const
 

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

Definition at line 291 of file koTemplateChooseDia.cc.

KoTemplateChooseDia::DialogType KoTemplateChooseDia::getDialogType (   )  const
 

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

Definition at line 295 of file koTemplateChooseDia.cc.

void KoTemplateChooseDia::slotOk (   )  [protected, virtual, slot]
 

Activated when the Ok button has been clicked.

Definition at line 635 of file koTemplateChooseDia.cc.

The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for lib Library Version 1.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Feb 13 09:41:24 2006 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003