NAME

App::Codit::Commands - Overview of available commands

DESCRIPTION

This is a list of available commands for App::Codit. You will find a link to the related module after the name the command. Please note that if the command is held by an extension or plugin that extension or plugin must be loaded for it to work.

A command can be executed as follows:

my $result = $app->cmdExecute('command_name', @options)
my @result = $app->cmdExecute('command_name', @options)

Generated: Wed Jan 8 10:52:21 2025

COMMANDS

about in Tk::AppWindow::Ext::Help

Pops the about box.

available_icon_sizes in Tk::AppWindow::Ext::Art

Returns a list of available icon sizes.

available_icon_themes in Tk::AppWindow::Ext::Art

Returns a list of available icon themes.

bm_plug_next in App::Codit::Plugins::Bookmarks

Jumps to the next selected bookmark.

bm_plug_previous in App::Codit::Plugins::Bookmarks

Jumps to the previous selected bookmark.

bookmark_add in App::Codit::Ext::CoditMDI

bookmark_clear in App::Codit::Ext::CoditMDI

bookmark_fill in App::Codit::Ext::CoditMDI

bookmark_next in App::Codit::Ext::CoditMDI

bookmark_prev in App::Codit::Ext::CoditMDI

bookmark_remove in App::Codit::Ext::CoditMDI

deferred_open in Tk::AppWindow::Ext::MDI

Takes a document name that is in deferred state as parameter and creates a new content handler for it. Returns a boolean indicating the succesfull load of its content.

doc_autoindent in App::Codit::Ext::CoditMDI

Sets and returns the autoindent option of the currently selected document.

doc_case_lower in App::Codit::Ext::CoditMDI

If there is a selection it turns it to lower case. Else it only turns the character at the insert position to lower case.

doc_case_upper in App::Codit::Ext::CoditMDI

If there is a selection it turns it to upper case. Else it only turns the character at the insert position to upper case.

doc_close in Tk::AppWindow::Ext::MDI

Takes a document name as parameter and closes it. If no parameter is specified closes the current selected document. Returns a boolean for succes or failure.

doc_delete in App::Codit::Ext::CoditMDI

Closes the current selected document and deletes the document file from disk. Use with caution.

doc_delete_dialog in App::Codit::Ext::CoditMDI

Same as doc_delete except it first asks nicely if you really want to do that.

doc_find in App::Codit::Ext::CoditMDI

Pops up the search bar in the currently selected document.

doc_fix_indent in App::Codit::Ext::CoditMDI

Asks for the number of spaces per tab and attempts to reformat the indentation taking the indentstyle into account.

If a selection exists it will do this for the selection, otherwise it will scan the whole document.

doc_get_sel in App::Codit::Ext::CoditMDI

Returns the begin and end index of the current selection.

doc_get_text $begin, $end in App::Codit::Ext::CoditMDI

Returns the text in the current selected document from index $begin to index $end.

doc_new in Tk::AppWindow::Ext::MDI

Takes a document name as parameter and creates a new document. If no parameter is specified an Untitled document is created. Returns a boolean for succes or failure.

doc_open in Tk::AppWindow::Ext::MDI

Takes a filename as parameter and opens it in deferred state. If no parameter is specified a file dialog is issued. Returns a boolean for succes or failure.

doc_remove_trailing in App::Codit::Ext::CoditMDI

Removes spaces at the end of each line.

If a selection exists it will do this for the selection, otherwise it will scan the whole document.

doc_rename in Tk::AppWindow::Ext::MDI

Takes two document names as parameters and renames the first one to the second one in the interface.

doc_replace in App::Codit::Ext::CoditMDI

Pops up the search and replace bar in the currently selected document.

doc_save in Tk::AppWindow::Ext::MDI

Takes a document name as parameter and saves it if it is modified. If no parameter is specified the current selected document is saved. Returns a boolean for succes or failure.

doc_save_all in Tk::AppWindow::Ext::MDI

Saves all open and modified documents. Returns a boolean for succes or failure.

doc_save_as in Tk::AppWindow::Ext::MDI

Takes a document name as parameter and issues a file dialog to rename it. If no parameter is specified the current selected document is initiated in the dialog. Returns a boolean for succes or failure.

doc_select in Tk::AppWindow::Ext::MDI

Select an opened document.

doc_wrap in App::Codit::Ext::CoditMDI

Sets and returns the wrap option of the currently selected document.

edit_delete, $begin, $end in App::Codit::Ext::CoditMDI

Deletes text in the currently selected document. It takes two indices as parameters.

edit_insert, $index, $text in App::Codit::Ext::CoditMDI

Inserts text in the currently selected document. It takes an index and a string as parameters.

edit_replace, $begin, $end, $text in App::Codit::Ext::CoditMDI

Replaces text in the currently selected document. It takes two indices and a text as parameters.

git_collapse in App::Codit::Plugins::Git

Collapses the git document tree and only opens the current selected document, if it is in the current selected repository.

git_command $project, $commandstring in App::Codit::Plugins::Git

Executes the git command in $commandstring for repository $project.

git_expand in App::Codit::Plugins::Git

Epxands the git document tree.

git_open_all in App::Codit::Plugins::Git

Opens all files in the current selected repository.

git_remove ?$name? in App::Codit::Plugins::Git

If $name is not specified, $name is the selected document.

Closes $name, Removes it from the current selected repository and deletes the file from disk. Use with care.

git_remove_dialog in App::Codit::Plugins::Git

Same as git_remove but first asks nicely if you really want to do this.

help in Tk::AppWindow::Ext::Help

Loads the helpfile in your system's default application or browser.

key_released, $doc, $key in App::Codit::Ext::CoditMDI

Dummy command only meant for hooking on by plugins. Called every time a visible character key was pressed.

modified, $doc, $index in App::Codit::Ext::CoditMDI

Called every time you make an edit, it gets a document name and an index as parameters. It checks if there are any macros that should be restarted. Many plugins hook on to this command.

plugsdialog in Tk::AppWindow::Ext::Plugins

Creates a dialog window in which the user can select and unselect plugins

pop_hist_menu in Tk::AppWindow::Ext::MDI

Is called when the file menu is opened in the menubar. It populates the 'Open recent' menu with the current history.

quit in Tk::AppWindow

Calls the CmdQuit method. See there.

set_title in Tk::AppWindow::Ext::MDI

Takes a document name as parameter and sets the main window title accordingly.

settings in Tk::AppWindow::Ext::Settings

Launches the settings dialog.

updates in Tk::AppWindow::Ext::Help

Pops the updates box and starts checking for updates.

LICENSE

Same as Perl.

AUTHOR

Hans Jeuken (hanje at cpan dot org)