Those functions are the plugable interface to extend cssed.
Definition in file plugin.h.
Go to the source code of this file.
Data Structures | |
| struct | _CssedPlugin |
| This object represents a plugin. More... | |
Typedefs | |
| typedef _CssedPluginPriv | CssedPluginPriv |
| typedef _CssedPlugin | CssedPlugin |
| A data type for _CssedPlugin structures. | |
Functions | |
| gint | cssed_plugin_get_position_at_line (CssedPlugin *plugin, gint line) |
| Returns the character position at the start of a line. | |
| void | cssed_plugin_unload_callback (GtkWidget *widget, gpointer plugin) |
| To be used as a widget callback. | |
| gboolean | cssed_add_menu_item_to_plugins_menu (CssedPlugin *plugin, GtkWidget *menu_item) |
| Adds a menu item to the plugin's menu. | |
| gboolean | cssed_plugin_add_widget_to_toolbar (CssedPlugin *plugin, GtkWidget *widget, const char *tooltip_text, const char *tooltip_private_text) |
| Adds a menu item to the toolbar. | |
| gboolean | cssed_plugin_add_page_with_widget_to_footer (CssedPlugin *plugin, GtkWidget *widget, gchar *label_text) |
| Adds a widget to the application's footer panel. | |
| gboolean | cssed_plugin_remove_page_with_widget_in_footer (CssedPlugin *plugin, GtkWidget *widget) |
| Removes a widget from the application's footer panel. | |
| gboolean | cssed_plugin_add_page_with_widget_to_sidebar (CssedPlugin *plugin, GtkWidget *widget, gchar *label_text) |
| Adds a widget to the sidebar. | |
| gboolean | cssed_plugin_remove_page_with_widget_in_sidebar (CssedPlugin *plugin, GtkWidget *widget) |
| Removes a widget from the application's side bar. | |
| gboolean | cssed_plugin_select_page_with_widget_in_sidebar (CssedPlugin *plugin, GtkWidget *widget) |
| Selects the page containing a widget. | |
| gboolean | cssed_plugin_select_page_with_widget_in_footer (CssedPlugin *plugin, GtkWidget *widget) |
| Selects the page containing a widget. | |
| void | cssed_plugin_error_message (gchar *title, gchar *message,...) |
| Shows an error message dialog. | |
| gboolean | cssed_plugin_confirm_dialog (gchar *title, gchar *message,...) |
| Shows a confirmation dialog. | |
| void | cssed_plugin_open_file (CssedPlugin *plugin, gchar *filename) |
| Opens a file. | |
| void | cssed_plugin_open_file_with_fileselector (CssedPlugin *plugin) |
| Shows a file selector dialog. | |
| void | cssed_plugin_add_text_to_document (CssedPlugin *plugin, gchar *text) |
| Adds the text passed to the document. | |
| gchar * | cssed_plugin_get_text (CssedPlugin *plugin) |
| Gets a null terminated string with the current document's text. | |
| void | cssed_plugin_select_text_range (CssedPlugin *plugin, gint start, gint end) |
| Selects a text range. | |
| gchar * | cssed_plugin_get_selected_text (CssedPlugin *plugin) |
| Gets a null terminated string with selected text. | |
| void | cssed_plugin_clear_selected_text (CssedPlugin *plugin) |
| Deletes the text selected. | |
| void | cssed_plugin_undo_document_action (CssedPlugin *plugin) |
| Undoes one previous action. | |
| void | cssed_plugin_redo_document_action (CssedPlugin *plugin) |
| Redoes one previous action. | |
| gboolean | cssed_plugin_document_can_redo (CssedPlugin *plugin) |
| Gets if a document have actions in the redo queue. | |
| gboolean | cssed_plugin_document_can_undo (CssedPlugin *plugin) |
| Gets if a document have actions in the undo queue. | |
| void | cssed_plugin_search_prev (CssedPlugin *plugin, gchar *text_to_search) |
| Backwards searches and selects some text. | |
| void | cssed_plugin_search_next (CssedPlugin *plugin, gchar *text_to_search) |
| Searches and selects some text. | |
| void | cssed_plugin_bookmark_next (CssedPlugin *plugin) |
| Goes to next bookmark if any. | |
| void | cssed_plugin_bookmark_prev (CssedPlugin *plugin) |
| Goes to previous bookmark if any. | |
| void | cssed_plugin_set_bookmark_at_line (CssedPlugin *plugin, gboolean set, gint line) |
| Set or unset a bookmark. | |
| gboolean | cssed_plugin_is_bookmark_set_at_line (CssedPlugin *plugin, gint line) |
| Queries if a bookmark is set on a given line. | |
| gboolean | cssed_plugin_marker_next (CssedPlugin *plugin) |
| Goes to next marker if any. | |
| gboolean | cssed_plugin_marker_prev (CssedPlugin *plugin) |
| Goes to previous marker if any. | |
| void | cssed_plugin_set_marker_at_line (CssedPlugin *plugin, gboolean set, gint line) |
| Set or unset a marker. | |
| gboolean | cssed_plugin_is_marker_set_at_line (CssedPlugin *plugin, gint line) |
| Queries if a marker is set on a given line. | |
| void | cssed_plugin_output_write (CssedPlugin *plugin, gchar *markup,...) |
| Send text to cssed's output. | |
| void | cssed_plugin_output_clear (CssedPlugin *plugin) |
| Clears cssed's output. | |
| gint | cssed_plugin_get_line_from_position (CssedPlugin *plugin, gint pos) |
| Returns the line number. | |
| gint | cssed_plugin_get_position_from_line (CssedPlugin *plugin, gint line) |
| Returns character position. | |
| gint | cssed_plugin_get_current_position (CssedPlugin *plugin) |
| Returns character position at the caret. | |
| void | cssed_plugin_set_current_position (CssedPlugin *plugin, gint pos) |
| Sets the current position . | |
| void | cssed_plugin_set_current_line (CssedPlugin *plugin, gint line) |
| Sets the current line. | |
| gint | cssed_plugin_get_current_line (CssedPlugin *plugin) |
| Returns the current line number. | |
| gint | cssed_plugin_get_line_end_from_position (CssedPlugin *plugin, gint pos) |
| Returns the character position at the end of the line. | |
| void | cssed_plugin_cut (CssedPlugin *plugin) |
| Cuts the selected text to the clipboard. | |
| void | cssed_plugin_copy (CssedPlugin *plugin) |
| Copy the selected text to the clipboard. | |
| void | cssed_plugin_paste (CssedPlugin *plugin) |
| Paste the clipboard contents. | |
| gint | cssed_plugin_get_selection_end (CssedPlugin *plugin) |
| Returns the selection's end. | |
| gint | cssed_plugin_get_selection_start (CssedPlugin *plugin) |
| Returns the selection's start. | |
| void | cssed_plugin_set_selection_start (CssedPlugin *plugin, gint start) |
| Sets the selection's start. | |
| void | cssed_plugin_set_selection_end (CssedPlugin *plugin, gint end) |
| Sets the selection's end. | |
| void | cssed_plugin_set_selection_range (CssedPlugin *plugin, gint start, gint end) |
| Selects a range of text. | |
| void | cssed_plugin_replace_sel (CssedPlugin *plugin, gchar *text) |
| Replaces the selected text. | |
| void | cssed_plugin_clear_sel (CssedPlugin *plugin) |
| Deletes the selected text. | |
| gint | cssed_plugin_get_length (CssedPlugin *plugin) |
| It gets the document's text length. | |
| void | cssed_plugin_show_user_list (CssedPlugin *plugin, gchar *list) |
| It shows a user list. | |
| void | cssed_plugin_show_autocompletion_list (CssedPlugin *plugin, gint len, gchar *list) |
| It shows an auto-completion list. | |
| void | cssed_plugin_autocompletion_cancel (CssedPlugin *plugin) |
| It hides any user list or auto-completion list being shown. | |
| gboolean | cssed_plugin_is_autocompletion_active (CssedPlugin *plugin) |
| It tells you if there's any list being shown. | |
| void | cssed_plugin_autocompletion_select (CssedPlugin *plugin, gchar *select) |
| It selects an item on a list if active. | |
| void | cssed_plugin_show_calltip (CssedPlugin *plugin, gint start, gchar *definition) |
| Shows a call tip. | |
| void | cssed_plugin_cancel_calltip (CssedPlugin *plugin) |
| Cancels a call tip. | |
| gboolean | cssed_plugin_calltipactive (CssedPlugin *plugin) |
| Informs wheter a calltip is currently active. | |
| gint | cssed_plugin_calltiposstart (CssedPlugin *plugin) |
| Returns the start point of a calltip. | |
| void | cssed_plugin_css_dialog_insert (CssedPlugin *plugin, gchar *key, gpointer klass) |
| Inserts a css dialog. | |
| void | cssed_plugin_css_dialog_remove_by_keyword (CssedPlugin *plugin, gchar *key) |
| Removes a css dialog. | |
| gpointer | cssed_plugin_css_dialog_lookup_by_keyword (CssedPlugin *plugin, gchar *key) |
| Returns a CssDialogClass defining a css dialog. | |
| gboolean | cssed_plugin_css_dialog_keyword_in_use (CssedPlugin *plugin, gchar *key) |
| Returns a boolean indicating if the given keyword is being used. | |
| gpointer | cssed_plugin_get_window (CssedPlugin *plugin) |
| Returns a pointer to the main CssedWindow. | |
| gpointer | cssed_plugin_send_scintilla_message (CssedPlugin *plugin, guint iMessage, gulong wParam, glong lParam) |
| Sends a message to the underlying scintilla editor control. | |
|
||||||||||||
|
Adds a menu item to the plugin's menu. This function lets you add an item to the plugin's menu, you must set the callbacks. yourself.
|
|
||||||||||||||||
|
Adds a widget to the application's footer panel. This function lets you add an item to the footer's panel, you must set the callbacks. yourself.
|
|
||||||||||||||||
|
Adds a widget to the sidebar. This function lets you add a widget to the sidebar, you must set the callbacks. yourself.
|
|
||||||||||||
|
Adds the text passed to the document. It adds the text passed to the document at the anchor position. The whole operation will be flagged as a single undo action.
|
|
||||||||||||||||||||
|
Adds a menu item to the toolbar. This function lets you add an item to the plugin's menu, you must set the callbacks. yourself.
|
|
|
It hides any user list or auto-completion list being shown. It hides any user list as well as any auto-completion list being shown. It does nothing if no user list nor auto-completion lists are running.
|
|
||||||||||||
|
It selects an item on a list if active. It selects the an item matching with the text passed as parameter if it exists.
|
|
|
Goes to next bookmark if any. Moves the caret to the next bookmark in current document. Or shows a message if no bookmarks exists.
|
|
|
Goes to previous bookmark if any. Moves the caret to the provious bookmark in current document. Or shows a message if no bookmarks exists.
|
|
|
Informs wheter a calltip is currently active. Returns a boolean indicating if there's a calltip activo or not
|
|
|
Returns the start point of a calltip. Returns an integer indicating the position where a calltip have been shown
|
|
|
Cancels a call tip. If a call tip is being show it hides it..
|
|
|
Deletes the selected text. It deletes the selected text on current document.
|
|
|
Deletes the text selected. If there's no selection this function has no effect.
|
|
||||||||||||||||
|
Shows a confirmation dialog. It prompts a confirmation dialog asking the user to make a choice. It may use printf style format on the message argument and a variable argument list matching this format. See the documentation on printf in your system.
|
|
|
Copy the selected text to the clipboard. It copies the selected text to the clipboard. The word "clipboard" will have a different meanings depending on the platform you're using.
|
|
||||||||||||||||
|
Inserts a css dialog. It inserts a css dialog defining a CSS property's value to be used by auto completion and quick insertion.
|
|
||||||||||||
|
Returns a boolean indicating if the given keyword is being used. The keyword is the trigger for most auto completion features.
|
|
||||||||||||
|
Returns a CssDialogClass defining a css dialog. It returns a CssDialogClass defining a CSS proerty's value to be used by auto completion.
|
|
||||||||||||
|
Removes a css dialog. It removes a css dialog defining a CSS property's value to be used by auto completion and quick insertion.
|
|
|
Cuts the selected text to the clipboard. It copies the selected text to the clipboard, and delete the selection. The word "clipboard" will have a different meanings depending on the platform you're using.
|
|
|
Gets if a document have actions in the redo queue. This function informs if the current document have actions in the redo queue.
|
|
|
Gets if a document have actions in the undo queue. This function informs if the current document have actions in the undo queue.
|
|
||||||||||||||||
|
Shows an error message dialog. It prompts a dialog to show an error to user, It may use printf style format on the message argument and a variable argument list matching this format. See the documentation on printf in your system.
|
|
|
Returns the current line number. It returns the line number where the caret is.
|
|
|
Returns character position at the caret. It returns the character position - 0 based index - at the text insertion point.
|
|
|
It gets the document's text length. It gets the length of current document, without the leading NULL character. You should allocate cssed_plugin_get_length + 1 bytes to store all document's text.
|
|
||||||||||||
|
Returns the character position at the end of the line. It returns the character position at the end of the line where the character shich position is passed as argument is.
|
|
||||||||||||
|
Returns the line number. It returns the line number - 0 based index - at a given character position.
|
|
||||||||||||
|
Returns the character position at the start of a line. It returns the character position as an integer, in the first character of the line number passed.
|
|
||||||||||||
|
Returns character position. It returns the character position - 0 based index - at a given line number.
|
|
|
Gets a null terminated string with selected text. You must free the returned valued if not NULL, with g_free.
|
|
|
Returns the selection's end. It returns the end of the selected text. If there are no text selected this function returns de same value as cssed_plugin_get_selection_start
|
|
|
Returns the selection's start. It returns the start of the selected text. If there are no text selected this function returns de same value as cssed_plugin_get_selection_end
|
|
|
Gets a null terminated string with the current document's text. You must free the returned valued if not NULL, with g_free.
|
|
|
Returns a pointer to the main CssedWindow. You must not free or modify this pointer. You must cast it to CssedWindow pointer - use (CssedWindow*) or CSSED_WINDOW() at your convenience. You should not free nor modify this pointer and use it only as parameter on function that require it.
|
|
|
It tells you if there's any list being shown. It returns a boolean indicating if there's any user or auto-completionm list active.
|
|
||||||||||||
|
Queries if a bookmark is set on a given line. It queries the bookmark state at a given line. It's recommended not to deal directly with bookmarks but to use markers instead. Bookmarks should be managed by the user and to change them - but in really speciallized cases - may be bothering.
|
|
||||||||||||
|
Queries if a marker is set on a given line. It queries the marker state at a given line.
|
|
|
Goes to next marker if any. Moves the caret to the next marker in current document. Or shows a message if no marker exists.
|
|
|
Goes to previous marker if any. Moves the caret to the provious marker in current document. Or shows a message if no marker exists.
|
|
||||||||||||
|
Opens a file. This function opens the file passed as "filename" in cssed.
|
|
|
Shows a file selector dialog. It prompts a dialog to let the user choose a file to be opened.
|
|
|
Clears cssed's output. It deletes all text on cssed's output window,.
|
|
||||||||||||||||
|
Send text to cssed's output. It sends text to cssed's output window, the text will be taken as pango markup so if you're sending an external command output to it, you should escape the text to be valid pango markup. It aceepts printf style format.
|
|
|
Paste the clipboard contents. It writes the text on the clipboard at text insertion point, deleting any selection. The word "clipboard" will have a different meanings depending on the platform you're using.
|
|
|
Redoes one previous action. It redoes the last action.
|
|
||||||||||||
|
Removes a widget from the application's footer panel. This function lets you remove a widget from the footer's panel
|
|
||||||||||||
|
Removes a widget from the application's side bar. This function lets you remove a widget from the side bar.
|
|
||||||||||||
|
Replaces the selected text. It replaces the selected text on current document, with the text passed as argument.
|
|
||||||||||||
|
Searches and selects some text. It searchs and selects the text passed as second parameter, searching from caret position to the document's end.
|
|
||||||||||||
|
Backwards searches and selects some text. It searches and selects the text passed second parameter going from caret position to the document's start.
|
|
||||||||||||
|
Selects the page containing a widget. This function selects the page containing the widget passed in the footer notebook.
|
|
||||||||||||
|
Selects the page containing a widget. This function selects the page containing the widget passed in the sidebar notebook.
|
|
||||||||||||||||
|
Selects a text range. The selection is done from character position "start", to character position "end".
|
|
||||||||||||||||||||
|
Sends a message to the underlying scintilla editor control. With this function you've got direct access to the scintilla editor control. You may visit scintilla.org for more information on this function.
|
|
||||||||||||||||
|
Set or unset a bookmark. It sets or unset a bookmark at a given line. It's recommended not to deal directly with bookmarks but to use markers instead. Bookmarks should be managed by the user and to change them - but in really speciallized cases - may be bothering.
|
|
||||||||||||
|
Sets the current line. It moves the text insertion point to the given line.
|
|
||||||||||||
|
Sets the current position . It moves the text insertion point to any given position.
|
|
||||||||||||||||
|
Set or unset a marker. It sets or unset a marker at a given line.
|
|
||||||||||||
|
Sets the selection's end. It sets the end of the selected text. It'll select the text from current selection's start or caret position if a call to cssed_plugin_set_selection_start was not made.
|