diff options
Diffstat (limited to 'src/__TODO/IndentHandler.cpp')
| -rw-r--r-- | src/__TODO/IndentHandler.cpp | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/src/__TODO/IndentHandler.cpp b/src/__TODO/IndentHandler.cpp index b0378a8..7175221 100644 --- a/src/__TODO/IndentHandler.cpp +++ b/src/__TODO/IndentHandler.cpp @@ -62,9 +62,9 @@ inline void UNUSED_PARAMETER_WARNING_AVOID(T) { } -//! \defgroup grp_Indenter All concerning handling of the indenter. +// \defgroup grp_Indenter All concerning handling of the indenter. -/*! +/* \class IndentHandler \ingroup grp_Indenter \brief A widget for handling many indenters that are configured by an ini file. @@ -76,7 +76,7 @@ inline void UNUSED_PARAMETER_WARNING_AVOID(T) */ -/*! +/* \brief Constructor of the indent handler. By calling this constructor the indenter to be loaded, can be selected by setting @@ -211,7 +211,7 @@ IndentHandler::IndentHandler(int indenterID, TQWidget *mainWindow, TQWidget *par retranslateUi(); } -/*! +/* \brief Implicitly writes the current indenter parameters to the indenters config file. */ IndentHandler::~IndentHandler() @@ -226,7 +226,7 @@ IndentHandler::~IndentHandler() delete _errorMessageDialog; } -/*! +/* \brief Initializes the context menu used for some actions like saving the indenter config file. */ void IndentHandler::initIndenterMenu() @@ -262,7 +262,7 @@ void IndentHandler::initIndenterMenu() } } -/*! +/* \brief Returns the context menu used for some actions like saving the indenter config file. */ TQMenu* IndentHandler::getIndenterMenu() @@ -270,7 +270,7 @@ TQMenu* IndentHandler::getIndenterMenu() return _menuIndenter; } -/*! +/* \brief Returns the actions of the context menu used for some actions like saving the indenter config file. */ TQList<TQAction*> IndentHandler::getIndenterMenuActions() @@ -281,7 +281,7 @@ TQList<TQAction*> IndentHandler::getIndenterMenuActions() return actionList; } -/*! +/* \brief Opens the context menu, used for some actions like saving the indenter config file, at the event position. */ void IndentHandler::contextMenuEvent(TQContextMenuEvent *event) @@ -289,7 +289,7 @@ void IndentHandler::contextMenuEvent(TQContextMenuEvent *event) getIndenterMenu()->exec(event->globalPos()); } -/*! +/* \brief Creates the content for a shell script that can be used as a external tool call to indent an as parameter defined file. */ @@ -400,7 +400,7 @@ TQString IndentHandler::generateShellScript(const TQString &configFilename) return shellScript; } -/*! +/* \brief Format \a sourceCode by calling the indenter. The \a inputFileExtension has to be given as parameter so the called indenter @@ -418,7 +418,7 @@ TQString IndentHandler::callIndenter(TQString sourceCode, TQString inputFileExte } } -/*! +/* \brief Format \a sourceCode by calling the interpreted JavaScript code of the indenter. The \a inputFileExtension has to be given as parameter so the called indenter @@ -442,7 +442,7 @@ TQString IndentHandler::callJavaScriptIndenter(TQString sourceCode) return value.toString(); } -/*! +/* \brief Format \a sourceCode by calling the binary executable of the indenter. The \a inputFileExtension has to be given as parameter so the called indenter @@ -755,7 +755,7 @@ TQString IndentHandler::callExecutableIndenter(TQString sourceCode, TQString inp return formattedSourceCode; } -/*! +/* \brief Generates and returns a string with all parameters needed to call the indenter. */ TQString IndentHandler::getParameterString() @@ -817,7 +817,7 @@ TQString IndentHandler::getParameterString() return parameterString; } -/*! +/* \brief Write settings for the indenter to a config file. */ void IndentHandler::saveConfigFile(TQString filePathName, TQString paramString) @@ -830,7 +830,7 @@ void IndentHandler::saveConfigFile(TQString filePathName, TQString paramString) cfgFile.close(); } -/*! +/* \brief Load the config file for the indenter and apply the settings made there. */ bool IndentHandler::loadConfigFile(TQString filePathName) @@ -1034,7 +1034,7 @@ bool IndentHandler::loadConfigFile(TQString filePathName) return true; } -/*! +/* \brief Sets all indenter parameters to their default values defined in the ini file. */ void IndentHandler::resetToDefaultValues() @@ -1076,7 +1076,7 @@ void IndentHandler::resetToDefaultValues() } } -/*! +/* \brief Opens and parses the indenter ini file that is declared by \a iniFilePath. */ void IndentHandler::readIndentIniFile(TQString iniFilePath) @@ -1417,7 +1417,7 @@ void IndentHandler::readIndentIniFile(TQString iniFilePath) } } -/*! +/* \brief Searches and returns all indenters a configuration file is found for. Opens all uigui ini files found in the list \a _indenterIniFileList, opens each ini file @@ -1453,7 +1453,7 @@ TQStringList IndentHandler::getAvailableIndenters() return indenterNamesList; } -/*! +/* \brief Deletes all elements in the toolbox and initializes the indenter selected by \a indenterID. */ void IndentHandler::setIndenter(int indenterID) @@ -1528,7 +1528,7 @@ void IndentHandler::setIndenter(int indenterID) #endif // UNIVERSALINDENTGUI_NPP_EXPORTS } -/*! +/* \brief Returns a string containing by the indenter supported file types/extensions divided by a space. */ TQString IndentHandler::getPossibleIndenterFileExtensions() @@ -1536,7 +1536,7 @@ TQString IndentHandler::getPossibleIndenterFileExtensions() return _fileTypes; } -/*! +/* \brief Returns the path and filename of the current indenter config file. */ TQString IndentHandler::getIndenterCfgFile() @@ -1545,7 +1545,7 @@ TQString IndentHandler::getIndenterCfgFile() return fileInfo.absoluteFilePath(); } -/*! +/* \brief Tries to create a call path string for the indenter executable. If successful returns true. */ bool IndentHandler::createIndenterCallString() @@ -1709,7 +1709,7 @@ bool IndentHandler::createIndenterCallString() return false; } -/*! +/* \brief Returns a string that points to where the indenters manual can be found. */ TQString IndentHandler::getManual() @@ -1724,7 +1724,7 @@ TQString IndentHandler::getManual() } } -/*! +/* \brief This slot gets the reference to the indenters manual and opens it. */ void IndentHandler::showIndenterManual() @@ -1733,7 +1733,7 @@ void IndentHandler::showIndenterManual() TQDesktopServices::openUrl(manualReference); } -/*! +/* \brief Can be called to update all widgets text to the currently selected language. */ void IndentHandler::retranslateUi() @@ -1776,7 +1776,7 @@ void IndentHandler::retranslateUi() "Resets all indenter parameters to the default values.", 0, TQApplication::UnicodeUTF8)); } -/*! +/* \brief Returns the name of the currently selected indenter. */ TQString IndentHandler::getCurrentIndenterName() @@ -1793,7 +1793,7 @@ TQString IndentHandler::getCurrentIndenterName() return currentIndenterName; } -/*! +/* \brief Shows a file open dialog to open an existing config file for the currently selected indenter. If the file was successfully opened the indent handler is called to load the settings and update itself. @@ -1815,7 +1815,7 @@ void IndentHandler::openConfigFileDialog() } } -/*! +/* \brief Calls the indenter config file save as dialog to save the config file under a chosen name. If the file already exists and it should be overwritten, a warning is shown before. @@ -1839,7 +1839,7 @@ void IndentHandler::saveasIndentCfgFileDialog() } } -/*! +/* \brief Invokes the indenter to create a shell script. Lets the indenter create a shell script for calling the indenter out of any @@ -1904,7 +1904,7 @@ void IndentHandler::createIndenterCallShellScript() } } -/*! +/* \brief Resets all parameters to the indenters default values as they are specified in the uigui ini file but asks the user whether to do it really. */ @@ -1919,7 +1919,7 @@ void IndentHandler::resetIndenterParameter() } } -/*! +/* \brief Catch some events and let some other be handled by the super class. Is needed for use as Notepad++ plugin. @@ -1943,7 +1943,7 @@ bool IndentHandler::event(TQEvent *event) } } -/*! +/* \brief Sets the function pointer \a _parameterChangedCallback to the given callback function \a paramChangedCallback. @@ -1954,7 +1954,7 @@ void IndentHandler::setParameterChangedCallback(void (*paramChangedCallback)(voi _parameterChangedCallback = paramChangedCallback; } -/*! +/* \brief Emits the \a indenterSettingsChanged signal and if set executes the \a _parameterChangedCallback function. Is needed for use as Notepad++ plugin. @@ -1969,7 +1969,7 @@ void IndentHandler::handleChangedIndenterSettings() } } -/*! +/* \brief Sets a callback function that shall be called, when the this indenter parameter window gets closed. Is needed for use as Notepad++ plugin. @@ -1979,7 +1979,7 @@ void IndentHandler::setWindowClosedCallback(void (*winClosedCallback)(void)) _windowClosedCallback = winClosedCallback; } -/*! +/* \brief Is called on this indenter parameter window close and if set calls the function \a _windowClosedCallback. Is needed for use as Notepad++ plugin. @@ -1993,7 +1993,7 @@ void IndentHandler::closeEvent(TQCloseEvent *event) event->accept(); } -/*! +/* \brief Returns the id (list index) of the currently selected indenter. */ int IndentHandler::getIndenterId() @@ -2023,7 +2023,7 @@ void IndentHandler::wheelEvent(TQWheelEvent *event) #endif // UNIVERSALINDENTGUI_NPP_EXPORTS } -/*! +/* \brief Converts characters < > and & in the \a text to HTML codes < > and &. */ |