Beaver 0.4.1
|
Data Structures | |
struct | beaver_text_selection_s |
struct | beaver_regex_result_s |
Defines | |
#define | PLUGIN_AUTHOR(name_string) |
#define | PLUGIN_VERSION(version_string) |
#define | PLUGIN_INIT(func_handler) |
#define | PLUGIN_CLEANUP(func_handler) |
#define | PLUGIN_NAME(name_string) |
#define | PLUGIN_DESCRIPTION(descr_string) |
#define | PLUGIN_PREFERENCE(func_handler) |
Typedefs | |
typedef struct beaver_text_selection_s | BeaverTextSelection |
typedef struct beaver_regex_result_s | BeaverRegexResult |
Enumerations | |
enum | BeaverMenuSection { BEAVER_SECTION_MENU_TOOLS = 0, BEAVER_SECTION_MENU_VIEW, BEAVER_SECTION_MENU_EDIT, BEAVER_SECTION_TOOLBAR } |
enum | BeaverTextFormat { BEAVER_FORMAT_UNIX = 0, BEAVER_FORMAT_MAC, BEAVER_FORMAT_DOS } |
Variables | |
void(* | beaver_box_message )(gchar *message) |
void(* | beaver_box_error )(gchar *message) |
gint(* | beaver_box_question )(gchar *message) |
gchar *(* | beaver_box_prompt )(gchar *message) |
gchar *(* | beaver_box_file_selection )(gchar *title, GtkFileChooserAction action, const gchar *starting_folder) |
gint(* | beaver_ui_item_add )(enum BeaverMenuSection section, const gchar *name, const gchar *stock_id, const gchar *text, void(*callback)(void)) |
gint(* | beaver_ui_item_submenu_add )(enum BeaverMenuSection section, const gchar *name, const gchar *text) |
gint(* | beaver_ui_item_seperator_add )(enum BeaverMenuSection section) |
void(* | beaver_ui_item_remove )(gint id, const gchar *name) |
void(* | beaver_text_insert_string )(const gchar *text) |
BeaverTextSelection *(* | beaver_text_selection_position )(void) |
gchar *(* | beaver_text_selection_get )(void) |
void(* | beaver_text_selection_set )(const gchar *text) |
enum BeaverTextFormat(* | beaver_text_format )(void) |
void(* | beaver_text_replace )(const gchar *needle, const gchar *substitute, gboolean sensitive) |
gboolean(* | beaver_text_find )(const gchar *needle, guint offset, gboolean sensitive) |
The Beaver API consists of several functions, enabling you to write plugins.
#define PLUGIN_AUTHOR | ( | name_string | ) |
gchar* __plugin_author (void) \ { \ return (name_string); \ }
Creates a function that returns a string identifying the author of this plugin.
name_string | name of the author |
#define PLUGIN_CLEANUP | ( | func_handler | ) |
void __plugin_cleanup (void) \ { \ (func_handler) (); \ }
Creates a function that calls a function for cleanup
func_handler | pointer to function that should be called. |
#define PLUGIN_DESCRIPTION | ( | descr_string | ) |
gchar* __plugin_description (void) \ { \ return (descr_string); \ }
Creates a function that returns a string identifying a short description about this plugin.
descr_string | a short description |
#define PLUGIN_INIT | ( | func_handler | ) |
void __plugin_init (void) \ { \ (func_handler) (); \ }
Creates a function that calls a function for initialization
func_handler | pointer to function that should be called. |
#define PLUGIN_NAME | ( | name_string | ) |
gchar* __plugin_name (void) \ { \ return (name_string); \ }
Creates a function that returns a string identifying the name of this plugin
name_string | name of this plugin |
#define PLUGIN_PREFERENCE | ( | func_handler | ) |
void __plugin_preference (void) \ { \ (func_handler) (); \ }
Creates a function that calls a function when the preferences button in the plugin manager was clicked.
func_handler | pointer to function that should be called. |
#define PLUGIN_VERSION | ( | version_string | ) |
gchar* __plugin_version (void) \ { \ return (version_string); \ }
Creates a function that returns a string identifying the version of this plugin
version_string | version |
enum BeaverMenuSection |
the different menu sections.
BEAVER_SECTION_MENU_TOOLS | |
BEAVER_SECTION_MENU_VIEW | |
BEAVER_SECTION_MENU_EDIT | |
BEAVER_SECTION_TOOLBAR |
enum BeaverTextFormat |
the different text formats
BEAVER_FORMAT_UNIX | |
BEAVER_FORMAT_MAC | |
BEAVER_FORMAT_DOS |
void(* beaver_box_error)(gchar *message) |
gchar*(* beaver_box_file_selection)(gchar *title, GtkFileChooserAction action, const gchar *starting_folder) |
void(* beaver_box_message)(gchar *message) |
gchar*(* beaver_box_prompt)(gchar *message) |
gint(* beaver_box_question)(gchar *message) |
gboolean(* beaver_text_find)(const gchar *needle, guint offset, gboolean sensitive) |
enum BeaverTextFormat(* beaver_text_format)(void) |
void(* beaver_text_insert_string)(const gchar *text) |
void(* beaver_text_replace)(const gchar *needle, const gchar *substitute, gboolean sensitive) |
gchar*(* beaver_text_selection_get)(void) |
void(* beaver_text_selection_set)(const gchar *text) |
gint(* beaver_ui_item_add)(enum BeaverMenuSection section, const gchar *name, const gchar *stock_id, const gchar *text, void(*callback)(void)) |
void(* beaver_ui_item_remove)(gint id, const gchar *name) |
gint(* beaver_ui_item_seperator_add)(enum BeaverMenuSection section) |
gint(* beaver_ui_item_submenu_add)(enum BeaverMenuSection section, const gchar *name, const gchar *text) |