plugin.h File Reference


Detailed Description

Header file for cssed plugin interface.

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.


Function Documentation

gboolean cssed_add_menu_item_to_plugins_menu CssedPlugin plugin,
GtkWidget *  menu_item
 

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.

Parameters:
plugin - A pointer to the plugin object.
menu_item - The menu item widget to add.

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.

This function lets you add an item to the footer's panel, you must set the callbacks. yourself.

Parameters:
plugin - A pointer to the plugin object.
widget - The menu item widget to add.
label_text - A text to be shown in the notebook's tab label.

gboolean cssed_plugin_add_page_with_widget_to_sidebar CssedPlugin plugin,
GtkWidget *  widget,
gchar *  label_text
 

Adds a widget to the sidebar.

This function lets you add a widget to the sidebar, you must set the callbacks. yourself.

Parameters:
plugin - A pointer to the plugin object.
widget - The widget to add.
label_text - A text to be shown in the notebook's tab label.

void cssed_plugin_add_text_to_document CssedPlugin plugin,
gchar *  text
 

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.

Parameters:
plugin - The plugin object.
text - The text to add to the document.

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.

This function lets you add an item to the plugin's menu, you must set the callbacks. yourself.

Parameters:
plugin - A pointer to the plugin object.
widget - The widget to add.
tooltip_text - The text shown to the user in a tool tip box.
tooltip_private_text - A biggest description to show to users.

void cssed_plugin_autocompletion_cancel CssedPlugin plugin  ) 
 

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.

Parameters:
plugin - The plugin object.

void cssed_plugin_autocompletion_select CssedPlugin plugin,
gchar *  select
 

It selects an item on a list if active.

It selects the an item matching with the text passed as parameter if it exists.

Parameters:
plugin - The plugin object.
select - The text to be selected on the list.

void cssed_plugin_bookmark_next CssedPlugin plugin  ) 
 

Goes to next bookmark if any.

Moves the caret to the next bookmark in current document. Or shows a message if no bookmarks exists.

Parameters:
plugin - The plugin object.

void cssed_plugin_bookmark_prev CssedPlugin plugin  ) 
 

Goes to previous bookmark if any.

Moves the caret to the provious bookmark in current document. Or shows a message if no bookmarks exists.

Parameters:
plugin - The plugin object.

gboolean cssed_plugin_calltipactive CssedPlugin plugin  ) 
 

Informs wheter a calltip is currently active.

Returns a boolean indicating if there's a calltip activo or not

Parameters:
plugin - The plugin object.

gint cssed_plugin_calltiposstart CssedPlugin plugin  ) 
 

Returns the start point of a calltip.

Returns an integer indicating the position where a calltip have been shown

Parameters:
plugin - The plugin object.

void cssed_plugin_cancel_calltip CssedPlugin plugin  ) 
 

Cancels a call tip.

If a call tip is being show it hides it..

Parameters:
plugin - The plugin object.

void cssed_plugin_clear_sel CssedPlugin plugin  ) 
 

Deletes the selected text.

It deletes the selected text on current document.

Parameters:
plugin - The plugin object.

void cssed_plugin_clear_selected_text CssedPlugin plugin  ) 
 

Deletes the text selected.

If there's no selection this function has no effect.

Parameters:
plugin - The plugin object.

gboolean cssed_plugin_confirm_dialog gchar *  title,
gchar *  message,
  ...
 

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.

Parameters:
title - Brief message.
message - Explained message.
Returns:
a boolean with the user's choice. TRUE if accepts the option explained in the message FALSE otherwise.

void cssed_plugin_copy CssedPlugin plugin  ) 
 

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.

Parameters:
plugin - The plugin object.

void cssed_plugin_css_dialog_insert CssedPlugin plugin,
gchar *  key,
gpointer  klass
 

Inserts a css dialog.

It inserts a css dialog defining a CSS property's value to be used by auto completion and quick insertion.

Parameters:
plugin - The plugin object.
key - A key defining this value, it must be surrounded by parens - as example (border).
klass - A CssedDialogClass defining the dialog.

gboolean cssed_plugin_css_dialog_keyword_in_use CssedPlugin plugin,
gchar *  key
 

Returns a boolean indicating if the given keyword is being used.

The keyword is the trigger for most auto completion features.

Parameters:
plugin - The plugin object.
key - The keyword.
Returns:
- A pointer to the CssDialogClass, or NULL if the key is not found.

gpointer cssed_plugin_css_dialog_lookup_by_keyword CssedPlugin plugin,
gchar *  key
 

Returns a CssDialogClass defining a css dialog.

It returns a CssDialogClass defining a CSS proerty's value to be used by auto completion.

Parameters:
plugin - The plugin object.
key - The key used to define this value.
Returns:
A pointer to the CssDialogClass you must cast it with (CssedDialogClass*)

void cssed_plugin_css_dialog_remove_by_keyword CssedPlugin plugin,
gchar *  key
 

Removes a css dialog.

It removes a css dialog defining a CSS property's value to be used by auto completion and quick insertion.

Parameters:
plugin - The plugin object.
key - The key used to define this value.

void cssed_plugin_cut CssedPlugin plugin  ) 
 

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.

Parameters:
plugin - The plugin object.

gboolean cssed_plugin_document_can_redo CssedPlugin plugin  ) 
 

Gets if a document have actions in the redo queue.

This function informs if the current document have actions in the redo queue.

Parameters:
plugin - The plugin object.
Returns:
A boolean indicating if there are actions in the redo queue.
Since:
0.2 (cssed-0.3.1)

gboolean cssed_plugin_document_can_undo CssedPlugin plugin  ) 
 

Gets if a document have actions in the undo queue.

This function informs if the current document have actions in the undo queue.

Parameters:
plugin - The plugin object.
Returns:
A boolean indicating if there are actions in the undo queue.
Since:
0.2 (cssed-0.3.1)

void cssed_plugin_error_message gchar *  title,
gchar *  message,
  ...
 

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.

Parameters:
title - Brief error message.
message - Explained error message.

gint cssed_plugin_get_current_line CssedPlugin plugin  ) 
 

Returns the current line number.

It returns the line number where the caret is.

Parameters:
plugin - The plugin object.
Returns:
an integer with the caret line.

gint cssed_plugin_get_current_position CssedPlugin plugin  ) 
 

Returns character position at the caret.

It returns the character position - 0 based index - at the text insertion point.

Parameters:
plugin - The plugin object.
Returns:
an integer with the caret position

gint cssed_plugin_get_length CssedPlugin plugin  ) 
 

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.

Parameters:
plugin - The plugin object.

gint cssed_plugin_get_line_end_from_position CssedPlugin plugin,
gint  pos
 

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.

Parameters:
plugin - The plugin object.
pos - The position from where to search the end of line.
Returns:
an integer with the character position at the end of the line.

gint cssed_plugin_get_line_from_position CssedPlugin plugin,
gint  pos
 

Returns the line number.

It returns the line number - 0 based index - at a given character position.

Parameters:
plugin - The plugin object.
pos - The character position.
Returns:
an integer with the line's number.

gint cssed_plugin_get_position_at_line CssedPlugin plugin,
gint  line
 

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.

Parameters:
plugin - The plugin object.
line - The line number to get the character position.
Returns:
an integer with the character position.
Deprecated:
This function is deprecated, use cssed_plugin_get_position_from_line instead.

gint cssed_plugin_get_position_from_line CssedPlugin plugin,
gint  line
 

Returns character position.

It returns the character position - 0 based index - at a given line number.

Parameters:
plugin - The plugin object.
line - The 0 based index of the line to query.
Returns:
an integer with the character position

gchar* cssed_plugin_get_selected_text CssedPlugin plugin  ) 
 

Gets a null terminated string with selected text.

You must free the returned valued if not NULL, with g_free.

Parameters:
plugin - The plugin object.
Returns:
- A pointer to the text or NULL if nothing is selected.
Warning:
You must free the returned value with g_free when no longer needed.

gint cssed_plugin_get_selection_end CssedPlugin plugin  ) 
 

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

Parameters:
plugin - The plugin object.
Returns:
an integer with the character position at selection's end.

gint cssed_plugin_get_selection_start CssedPlugin plugin  ) 
 

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

Parameters:
plugin - The plugin object.
Returns:
an integer with the character position at selection's start.

gchar* cssed_plugin_get_text CssedPlugin plugin  ) 
 

Gets a null terminated string with the current document's text.

You must free the returned valued if not NULL, with g_free.

Parameters:
plugin - The plugin object.
Returns:
- A pointer to the text.
Warning:
You must free the returned value with g_free when no longer needed.

gpointer cssed_plugin_get_window CssedPlugin plugin  ) 
 

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.

Parameters:
plugin - The plugin object.
Returns:
- The main cssed window object.

gboolean cssed_plugin_is_autocompletion_active CssedPlugin plugin  ) 
 

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.

Parameters:
plugin - The plugin object.
Returns:
A boolean idicating if there's a list active.

gboolean cssed_plugin_is_bookmark_set_at_line CssedPlugin plugin,
gint  line
 

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.

Parameters:
plugin - The plugin object.
line - The 0 based index of the line to query.
Returns:
a boolean idicating if the bookmar is set.

gboolean cssed_plugin_is_marker_set_at_line CssedPlugin plugin,
gint  line
 

Queries if a marker is set on a given line.

It queries the marker state at a given line.

Parameters:
plugin - The plugin object.
line - The 0 based index of the line to query.
Returns:
a boolean idicating if the bookmar is set.

gboolean cssed_plugin_marker_next CssedPlugin plugin  ) 
 

Goes to next marker if any.

Moves the caret to the next marker in current document. Or shows a message if no marker exists.

Parameters:
plugin - The plugin object.

gboolean cssed_plugin_marker_prev CssedPlugin plugin  ) 
 

Goes to previous marker if any.

Moves the caret to the provious marker in current document. Or shows a message if no marker exists.

Parameters:
plugin - The plugin object.

void cssed_plugin_open_file CssedPlugin plugin,
gchar *  filename
 

Opens a file.

This function opens the file passed as "filename" in cssed.

Parameters:
plugin - The plugin object.
filename - Full path to the file to be opened.

void cssed_plugin_open_file_with_fileselector CssedPlugin plugin  ) 
 

Shows a file selector dialog.

It prompts a dialog to let the user choose a file to be opened.

Parameters:
plugin - The plugin object.

void cssed_plugin_output_clear CssedPlugin plugin  ) 
 

Clears cssed's output.

It deletes all text on cssed's output window,.

Parameters:
plugin - The plugin object.

void cssed_plugin_output_write CssedPlugin plugin,
gchar *  markup,
  ...
 

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.

Parameters:
plugin - The plugin object.
markup - The pango markup to show in the output window.

void cssed_plugin_paste CssedPlugin plugin  ) 
 

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.

Parameters:
plugin - The plugin object.

void cssed_plugin_redo_document_action CssedPlugin plugin  ) 
 

Redoes one previous action.

It redoes the last action.

Parameters:
plugin - The plugin object.

gboolean cssed_plugin_remove_page_with_widget_in_footer CssedPlugin plugin,
GtkWidget *  widget
 

Removes a widget from the application's footer panel.

This function lets you remove a widget from the footer's panel

Parameters:
plugin - A pointer to the plugin object.
widget - The widget to be removed.

gboolean cssed_plugin_remove_page_with_widget_in_sidebar CssedPlugin plugin,
GtkWidget *  widget
 

Removes a widget from the application's side bar.

This function lets you remove a widget from the side bar.

Parameters:
plugin - A pointer to the plugin object.
widget - The widget to be removed.

void cssed_plugin_replace_sel CssedPlugin plugin,
gchar *  text
 

Replaces the selected text.

It replaces the selected text on current document, with the text passed as argument.

Parameters:
plugin - The plugin object.
text - The replacement text.

void cssed_plugin_search_next CssedPlugin plugin,
gchar *  text_to_search
 

Searches and selects some text.

It searchs and selects the text passed as second parameter, searching from caret position to the document's end.

Parameters:
plugin - The plugin object.
text_to_search - The text to search for.

void cssed_plugin_search_prev CssedPlugin plugin,
gchar *  text_to_search
 

Backwards searches and selects some text.

It searches and selects the text passed second parameter going from caret position to the document's start.

Parameters:
plugin - The plugin object.
text_to_search - The text to search for.
Since:
0.2 (cssed-0.3.1)

gboolean cssed_plugin_select_page_with_widget_in_footer CssedPlugin plugin,
GtkWidget *  widget
 

Selects the page containing a widget.

This function selects the page containing the widget passed in the footer notebook.

Parameters:
plugin - A pointer to the plugin object.
widget - The widget to be selected.

gboolean cssed_plugin_select_page_with_widget_in_sidebar CssedPlugin plugin,
GtkWidget *  widget
 

Selects the page containing a widget.

This function selects the page containing the widget passed in the sidebar notebook.

Parameters:
plugin - A pointer to the plugin object.
widget - The widget to be selected.

void cssed_plugin_select_text_range CssedPlugin plugin,
gint  start,
gint  end
 

Selects a text range.

The selection is done from character position "start", to character position "end".

Parameters:
plugin - The plugin object.
start - An integer containing the start of selection.
end - An integer containing the end of selection.
Deprecated:
This function is deprecated and should not be used in newly written code, use cssed_plugin_set_selection_range instead.

gpointer cssed_plugin_send_scintilla_message CssedPlugin plugin,
guint  iMessage,
gulong  wParam,
glong  lParam
 

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.

Parameters:
plugin - The plugin object.
iMessage - The message identifier object.
wParam - message parameter.
lParam - message parameter.
Returns:
- The return value depends on the message sent.

void cssed_plugin_set_bookmark_at_line CssedPlugin plugin,
gboolean  set,
gint  line
 

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.

Parameters:
plugin - The plugin object.
set - TRUE to set the bookmar, FALSE to unset it.
line - The 0 based index of the line where the bookmark is set.

void cssed_plugin_set_current_line CssedPlugin plugin,
gint  line
 

Sets the current line.

It moves the text insertion point to the given line.

Parameters:
plugin - The plugin object.
line - The line where to move the caret.

void cssed_plugin_set_current_position CssedPlugin plugin,
gint  pos
 

Sets the current position .

It moves the text insertion point to any given position.

Parameters:
plugin - The plugin object.
pos - The position where to move the caret.

void cssed_plugin_set_marker_at_line CssedPlugin plugin,
gboolean  set,
gint  line
 

Set or unset a marker.

It sets or unset a marker at a given line.

Parameters:
plugin - The plugin object.
set - TRUE to set the bookmar, FALSE to unset it.
line - The 0 based index of the line where the bookmark is set.

void cssed_plugin_set_selection_end CssedPlugin plugin,
gint  end
 

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.

Parameters:
plugin - The plugin object.
end - The selection's end.

void cssed_plugin_set_selection_range CssedPlugin plugin,
gint  start,
gint  end
 

Selects a range of text.

It selects a range of text from start to end. Is as to call cssed_plugin_set_selection_start cssed_plugin_set_selection_end in one single call.

Parameters:
plugin - The plugin object.
start - The selection's end.
end - The selection's end.

void cssed_plugin_set_selection_start CssedPlugin plugin,
gint  start
 

Sets the selection's start.

It sets the start of the selected text. you need to call cssed_plugin_set_selection_end to select a range of text.

Parameters:
plugin - The plugin object.
start - The selection's start.

void cssed_plugin_show_autocompletion_list CssedPlugin plugin,
gint  len,
gchar *  list
 

It shows an auto-completion list.

It shows a pop window with the elements passed as argument shown as a list to let the user to choose among one of them. As the user types, the list is scrolled to show the best match if any.

Parameters:
plugin - The plugin object.
len - the length of the text entered by the user - to auto complete it.
list - An string containing the space separated elements of the list.

void cssed_plugin_show_calltip CssedPlugin plugin,
gint  start,
gchar *  definition
 

Shows a call tip.

Shows an small windown with information as function signatures.

Parameters:
plugin - The plugin object.
start - The character position where to show the call tip.
definition - The text to be shown.

void cssed_plugin_show_user_list CssedPlugin plugin,
gchar *  list
 

It shows a user list.

It shows a pop window with the elements passed as argument shown as a list to let the user to choose among one of them.

Parameters:
plugin - The plugin object.
list - An string containing the space separated elements of the list.

void cssed_plugin_undo_document_action CssedPlugin plugin  ) 
 

Undoes one previous action.

It undoes the last text or character insertion in the document.

Parameters:
plugin - The plugin object.

void cssed_plugin_unload_callback GtkWidget *  widget,
gpointer  plugin
 

To be used as a widget callback.

This function lets you unload the plugin from a signal, using it as the signal's callback.

Parameters:
widget - The widget that caused the signal.
plugin - A pointer to the plugin object.


Back to Index

This documentation is © Iago Rubio Sanfiz, 2004