• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kate
 

kate

Public Member Functions | Public Attributes | List of all members
KateExternalTool Class Reference

#include <kateexternaltools.h>

Public Member Functions

 KateExternalTool (const TQString &name=TQString::null, const TQString &command=TQString::null, const TQString &icon=TQString::null, const TQString &tryexec=TQString::null, const TQStringList &mimetypes=TQStringList(), const TQString &acname=TQString::null, const TQString &cmdname=TQString::null, int save=0)
bool valid (const TQString &mimetype) const
bool checkExec ()

Public Attributes

TQString name
TQString command
TQString icon
TQString tryexec
TQStringList mimetypes
bool hasexec
TQString acname
TQString cmdname
int save

Detailed Description

This class defines a single external tool.

Definition at line 100 of file kateexternaltools.h.

Member Function Documentation

bool KateExternalTool::checkExec ( )
Returns
true if "tryexec" exists and has the executable bit set, or is empty. This is run at least once, and the tool is disabled if it fails.

Definition at line 89 of file kateexternaltools.cpp.

bool KateExternalTool::valid ( const TQString &  mimetype) const
Returns
true if mimetypes is empty, or the mimetype matches.

Definition at line 128 of file kateexternaltools.cpp.

Member Data Documentation

TQString KateExternalTool::acname

The name for the action. This is generated first time the action is is created.

Definition at line 119 of file kateexternaltools.h.

TQString KateExternalTool::cmdname

The name for the commandline.

Definition at line 120 of file kateexternaltools.h.

TQString KateExternalTool::command

The command to execute.

Definition at line 114 of file kateexternaltools.h.

bool KateExternalTool::hasexec

This is set by the constructor by calling checkExec(), if a value is present.

Definition at line 118 of file kateexternaltools.h.

TQString KateExternalTool::icon

the icon to use in the menu.

Definition at line 115 of file kateexternaltools.h.

TQStringList KateExternalTool::mimetypes

Optional list of mimetypes for which this action is valid.

Definition at line 117 of file kateexternaltools.h.

TQString KateExternalTool::name

The name used in the menu.

Definition at line 111 of file kateexternaltools.h.

int KateExternalTool::save

We can save documents prior to activating the tool command: 0 = nothing, 1 = current document, 2 = all documents.

Definition at line 121 of file kateexternaltools.h.

TQString KateExternalTool::tryexec

The name or path of the executable.

Definition at line 116 of file kateexternaltools.h.


The documentation for this class was generated from the following files:
  • kateexternaltools.h
  • kateexternaltools.cpp

kate

Skip menu "kate"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kate

Skip menu "kate"
  • kate
  • libkonq
  • twin
  •   lib
Generated for kate by doxygen 1.8.1.2
This website is maintained by Timothy Pearson.