# class KTextEditor.TemplateInterface

### abstract class

Table of contents
Modules
ktexteditor Classes
All Classes

Module | ktexteditor
Namespace | ktexteditor
Class | KTextEditor.TemplateInterface
Inherits |

This is an interface for inserting template strings with user editable fields into a document.

### methods

- TemplateInterface ()

  returns nothing

- expandMacros (initialValues, parentWindow)

  returns (bool)
  static

  Argument | Type | Default
  --- | --- | ---
  initialValues | dict of (QString, QString) |
  parentWindow | QWidget |

  Parses templateString for macros in the form [$%]{NAME} and finds the value corresponding to NAME if any. The NAME string may contain any non-whitespace character execpt '}'

  initialValues - a map with the keys for the macros to expand. keys with a value are ignored.

  parentWindow - is used if dialogs have to be shown Returns true if all macros was successfully expanded

  See also insertTemplateText for a list of supported macros

- insertTemplateText (insertPosition, templateString, initialValues)

  returns (bool)

  Argument | Type | Default
  --- | --- | ---
  insertPosition | KTextEditor.Cursor |
  templateString | QString |
  initialValues | dict of (QString, QString) |

  Inserts an interactive ediable template text at line "line", column "col". Returns true if inserting the string succeeded

  Use insertTemplateText(numLines(), ...) to append text at end of document Template strings look like "for( int ${index}=0;${index}<10;${index}++) { ${cursor} };" or "%{date}"

  This syntax is somewhat similar to the one found in the Eclipse editor.

  There are certain common placeholders (macros), which get assigned a default initialValue, If the second parameter does not a given value. For all others the initial value is the name of the placeholder.

  Placeholder names may only consist of a-zA-Z0-9_ Common placeholders and values are

  - index: "i" - loginname: The current users's loginname - firstname: The current user's first name retrieved from kabc - lastname: The current user's last name retrieved from kabc - fullname: The current user's first and last name retrieved from kabc - email: The current user's primary email address retrieved from kabc - date: current date - time: current time - year: current year - month: current month - day: current day - hostname: hostname of the computer - cursor: at this position the cursor will be after editing of the template has finished, this has to be taken care of by the actual implementation. The placeholder gets a value of "|" assigned.

  If a macro is started with a % (persent sign) like "%{date}" it isn't added to the list editable strings ( for example TAB key navigation) if a value differing from the macro name is found.

  If the editor supports some kind of smart indentation, the inserted code should be layouted by the indenter.

- insertTemplateTextImplementation (insertPosition, templateString, initialValues)

  returns (bool)
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  insertPosition | KTextEditor.Cursor |
  templateString | QString |
  initialValues | dict of (QString, QString) |

  You must implement this, it is called by insertTemplateText, after all default values are inserted. If you are implementing this interface, this method should work as described in the documentation for insertTemplateText above. Returns true if any text was inserted.