• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • KDevelop Extension Interfaces Library
 

KDevelop Extension Interfaces Library

Classes | Public Member Functions | List of all members
KDevCreateFile Class Referenceabstract

#include <kdevcreatefile.h>

Inherits KDevPlugin.

Classes

class  CreatedFile
 

Public Member Functions

 KDevCreateFile (const KDevPluginInfo *info, TQObject *parent=0, const char *name=0)
 
virtual CreatedFile createNewFile (TQString ext=TQString(), TQString dir=TQString(), TQString name=TQString(), TQString subtype=TQString())=0
 

Detailed Description

File creation facility interface.

An abstract class for all extensions that are responsible for file creation.

Instances that implement this interface are available through extension architecture:

KDevCreateFile *cf = extension<KDevCreateFile>("TDevelop/CreateFile");
if (cf) {
// do something
} else {
// fail
}
See also
KDevPlugin::extension method documentation.

Definition at line 48 of file kdevcreatefile.h.

Constructor & Destructor Documentation

◆ KDevCreateFile()

KDevCreateFile::KDevCreateFile ( const KDevPluginInfo *  info,
TQObject *  parent = 0,
const char *  name = 0 
)
inline

Constructor.

Parameters
infoImportant information about the plugin - plugin internal and generic (GUI) name, description, a list of authors, etc. That information is used to show plugin information in various places like "about application" dialog, plugin selector dialog, etc. Plugin does not take ownership on info object, also its lifetime should be equal to the lifetime of the plugin.
parentThe parent object for the plugin. Parent object must implement KDevApi interface. Otherwise the plugin will not be constructed.
nameThe internal name which identifies the plugin.

Definition at line 125 of file kdevcreatefile.h.

Member Function Documentation

◆ createNewFile()

virtual CreatedFile KDevCreateFile::createNewFile ( TQString  ext = TQString(),
TQString  dir = TQString(),
TQString  name = TQString(),
TQString  subtype = TQString() 
)
pure virtual

Creates a new file, within or without the project.

Supply as much information as you know. Leave what you don't know as TQString(). The user will be prompted as necessary for the missing information, and the file created, and added to the project as necessary.

Parameters
extFile extension (type).
dirThe absolute path to a directory.
nameThe name of a file.
subtypeThe subtype, pass this only if an extension is not enough to find the file template.
Returns
CreatedFile instance with information about file and file creation process.

The documentation for this class was generated from the following file:
  • kdevcreatefile.h

KDevelop Extension Interfaces Library

Skip menu "KDevelop Extension Interfaces Library"
  • Main Page
  • Alphabetical List
  • Class List
  • File List
  • Class Members

KDevelop Extension Interfaces Library

Skip menu "KDevelop Extension Interfaces Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for KDevelop Extension Interfaces Library by doxygen 1.8.13
This website is maintained by Timothy Pearson.