stat.h File Reference

#include <libheraia.h>

Include dependency graph for stat.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  histo_infos_t
struct  stat_t
 This is the stat structure. More...

Defines

#define API_VERSION   1
#define PLUGIN_TYPE   HERAIA_PLUGIN_ACTION
#define PLUGIN_NAME   "stat"
#define PLUGIN_VERSION   "1"
#define PLUGIN_SUMMARY   "stat"
#define PLUGIN_DESCRIPTION   "Does some stats on the opened file"
#define PLUGIN_AUTHOR   "Olivier Delhomme <heraia@delhomme.org>"
#define PLUGIN_HOMEPAGE   "http://heraia.tuxfamily.org/"

Functions

void init (heraia_window_t *)
 The plugin interface functions.
void quit (void)
 Normaly this is called when the plugin is unloaded One may wait it's entire life for this to be called !! ;).
void run (GtkWidget *, gpointer)
 This function is called via a signal handler when the menu entry is toggled.
void refresh (heraia_window_t *, void *)
 The refresh function is called when a new file is loaded or when the cursor is moved Here we want to refresh the plugin only if a new file is loaded AND if the plugin is already displayed (running).
heraia_plugin_theraia_plugin_init (heraia_plugin_t *)
 Initialisation plugin function called when the plugin is loaded (some sort of pre-init).


Define Documentation

#define API_VERSION   1

Definition at line 31 of file stat.h.

Referenced by heraia_plugin_init().

#define PLUGIN_AUTHOR   "Olivier Delhomme <heraia@delhomme.org>"

Definition at line 38 of file stat.h.

Referenced by heraia_plugin_init().

#define PLUGIN_DESCRIPTION   "Does some stats on the opened file"

Definition at line 37 of file stat.h.

Referenced by heraia_plugin_init().

#define PLUGIN_HOMEPAGE   "http://heraia.tuxfamily.org/"

Definition at line 39 of file stat.h.

Referenced by heraia_plugin_init().

#define PLUGIN_NAME   "stat"

Definition at line 34 of file stat.h.

Referenced by heraia_plugin_init(), init(), quit(), and run().

#define PLUGIN_SUMMARY   "stat"

Definition at line 36 of file stat.h.

Referenced by heraia_plugin_init().

#define PLUGIN_TYPE   HERAIA_PLUGIN_ACTION

Definition at line 32 of file stat.h.

Referenced by heraia_plugin_init().

#define PLUGIN_VERSION   "1"

Definition at line 35 of file stat.h.

Referenced by heraia_plugin_init().


Function Documentation

heraia_plugin_t* heraia_plugin_init ( heraia_plugin_t plugin  ) 

void init ( heraia_window_t main_struct  ) 

The plugin interface functions.

The plugin interface functions.

Parameters:
main_struct : main structure

Definition at line 112 of file stat.c.

References plugin_info_t::author, heraia_plugin_t::cmi_entry, window_prop_t::displayed, find_plugin_by_name(), heraia_plugin_t::info, load_plugin_glade_xml(), log_message(), plugin_info_t::name, PLUGIN_NAME, heraia_window_t::plugins_list, stat_window_connect_signals(), heraia_plugin_t::win_prop, and heraia_plugin_t::xml.

Referenced by heraia_plugin_init().

Here is the call graph for this function:

Here is the caller graph for this function:

void quit ( void   ) 

Normaly this is called when the plugin is unloaded One may wait it's entire life for this to be called !! ;).

Definition at line 159 of file stat.c.

References PLUGIN_NAME.

Referenced by heraia_plugin_init().

Here is the caller graph for this function:

void refresh ( heraia_window_t main_struct,
void *  data 
)

The refresh function is called when a new file is loaded or when the cursor is moved Here we want to refresh the plugin only if a new file is loaded AND if the plugin is already displayed (running).

Parameters:
main_struct : main structure
data : user data (the plugin itself) MUST be heraia_plugin_t *plugin structure

Definition at line 205 of file stat.c.

References heraia_window_t::event, HERAIA_REFRESH_NEW_FILE, PLUGIN_STATE_RUNNING, heraia_plugin_t::run_proc, heraia_plugin_t::state, and heraia_plugin_t::xml.

Referenced by heraia_plugin_init().

Here is the caller graph for this function:

void run ( GtkWidget *  widget,
gpointer  data 
)

This function is called via a signal handler when the menu entry is toggled.

Parameters:
widget : widget which called the function (unused)
data : user data for the plugin, here MUST be heraia_window_t * main structure

Definition at line 172 of file stat.c.

References heraia_plugin_t::cmi_entry, find_plugin_by_name(), PLUGIN_NAME, PLUGIN_STATE_NONE, PLUGIN_STATE_RUNNING, heraia_window_t::plugins_list, realize_some_numerical_stat(), show_hide_widget(), heraia_plugin_t::state, heraia_plugin_t::win_prop, and heraia_plugin_t::xml.

Referenced by heraia_plugin_init().

Here is the call graph for this function:

Here is the caller graph for this function:


Generated on Sat Mar 14 13:44:50 2009 for Heraia by  doxygen 1.5.6