kpguiutils

kpguiutils —

Synopsis




#define     CB                              (func)
#define     KP_W                            (xml,widget)
            GuiModuleSignalsData;
void        kp_gui_err_message              (GtkWindow *parent,
                                             const gchar *format,
                                             ...);
void        kp_gui_info_message             (GtkWindow *parent,
                                             const gchar *format,
                                             ...);
GladeXML*   kp_gui_load                     (const gchar *module,
                                             const gchar *root);
void        kp_gui_module_signals_connect   (GladeXML *xml,
                                             GuiModuleSignalsData *gmd);
void        kp_gui_module_signals_connect_data
                                            (GladeXML *xml,
                                             GuiModuleSignalsData *gmd,
                                             gpointer data);
gint        kp_gui_get_combo_box_index      (GtkComboBox *box,
                                             const gchar *key);
gint        kp_gui_get_yes_no_cancel        (GtkWindow *window,
                                             const gchar *message);
gboolean    kp_gui_ask_if_user_wants_to_replace
                                            (GtkWindow *window,
                                             const gchar *file);
GtkResponseType kp_gui_ask_if_user_wants_to_save
                                            (GtkWindow *window);
GtkResponseType kp_gui_ask_if_user_wants_to_save_old_log
                                            (GtkWindow *window);
gchar*      kp_gui_get_file_to_open         (GtkWindow *parent);
gchar*      kp_gui_get_file_to_save         (GtkWindow *parent);
gchar*      kp_gui_get_dir                  (GtkWindow *parent);
void        kp_gui_open_file_dialog         (GCallback handler);
GtkWidget*  kp_gui_get_widget               (GladeXML *xml,
                                             const gchar *widget_name);
gchar*      kp_gui_get_option_menu_active   (GtkOptionMenu *menu);
void        kp_gui_report_error             (GtkWindow *window,
                                             KPStatusbar *bar,
                                             const gchar *msg);
void        kp_gui_destroy_widget_passed    (GtkWidget *widget,
                                             gpointer data);
void        kp_gui_get_dates_for_view_type  (GDate *date,
                                             KPViewModelType type,
                                             GDate **start,
                                             GDate **end,
                                             KPTrainingLog *log);
gchar*      kp_get_combo_box_first_entry    (GtkComboBox *box);
GdkPixbuf*  kp_get_icon_as_pixbuf           (const gchar *icon);
GtkImage*   kp_get_icon_as_image            (const gchar *icon);
gchar*      kp_get_icon_filename            (const gchar *icon);
void        kp_color_from_markup            (const gchar *markup,
                                             GdkColor *color);
gchar*      kp_color_str_to_markup          (const gchar *color);
gchar*      kp_color_to_markup              (GdkColor *color);

Description

Details

CB()

#define CB(func) (G_CALLBACK (func))

func :

KP_W()

#define KP_W(xml,widget) kp_gui_get_widget(xml,widget)

xml :
widget :

GuiModuleSignalsData

typedef struct {
  const gchar   *glade_widget_name;
  const gchar   *signal;
  GCallback      callback;
  gpointer       data;
} GuiModuleSignalsData;


kp_gui_err_message ()

void        kp_gui_err_message              (GtkWindow *parent,
                                             const gchar *format,
                                             ...);

parent :
format :
... :

kp_gui_info_message ()

void        kp_gui_info_message             (GtkWindow *parent,
                                             const gchar *format,
                                             ...);

parent :
format :
... :

kp_gui_load ()

GladeXML*   kp_gui_load                     (const gchar *module,
                                             const gchar *root);

module :
root :
Returns :

kp_gui_module_signals_connect ()

void        kp_gui_module_signals_connect   (GladeXML *xml,
                                             GuiModuleSignalsData *gmd);

xml :
gmd :

kp_gui_module_signals_connect_data ()

void        kp_gui_module_signals_connect_data
                                            (GladeXML *xml,
                                             GuiModuleSignalsData *gmd,
                                             gpointer data);

xml :
gmd :
data :

kp_gui_get_combo_box_index ()

gint        kp_gui_get_combo_box_index      (GtkComboBox *box,
                                             const gchar *key);

box :
key :
Returns :

kp_gui_get_yes_no_cancel ()

gint        kp_gui_get_yes_no_cancel        (GtkWindow *window,
                                             const gchar *message);

window :
message :
Returns :

kp_gui_ask_if_user_wants_to_replace ()

gboolean    kp_gui_ask_if_user_wants_to_replace
                                            (GtkWindow *window,
                                             const gchar *file);

window :
file :
Returns :

kp_gui_ask_if_user_wants_to_save ()

GtkResponseType kp_gui_ask_if_user_wants_to_save
                                            (GtkWindow *window);

window :
Returns :

kp_gui_ask_if_user_wants_to_save_old_log ()

GtkResponseType kp_gui_ask_if_user_wants_to_save_old_log
                                            (GtkWindow *window);

window :
Returns :

kp_gui_get_file_to_open ()

gchar*      kp_gui_get_file_to_open         (GtkWindow *parent);

parent :
Returns :

kp_gui_get_file_to_save ()

gchar*      kp_gui_get_file_to_save         (GtkWindow *parent);

parent :
Returns :

kp_gui_get_dir ()

gchar*      kp_gui_get_dir                  (GtkWindow *parent);

parent :
Returns :

kp_gui_open_file_dialog ()

void        kp_gui_open_file_dialog         (GCallback handler);

handler :

kp_gui_get_widget ()

GtkWidget*  kp_gui_get_widget               (GladeXML *xml,
                                             const gchar *widget_name);

xml :
widget_name :
Returns :

kp_gui_get_option_menu_active ()

gchar*      kp_gui_get_option_menu_active   (GtkOptionMenu *menu);

Get the text of the currently selected item of the GtkOptionMenu.

menu : A GtkOptionMenu
Returns : The text of the active item or NULL if something goes wrong. If the value is not NULL, it must be freed by the caller.

kp_gui_report_error ()

void        kp_gui_report_error             (GtkWindow *window,
                                             KPStatusbar *bar,
                                             const gchar *msg);

Show this error message to the user.

window : Parent window for the dialog
bar : A KPStatusbar, can be NULL if msg is not wanted to be shown in the statusbar
msg : Message to show to the user

kp_gui_destroy_widget_passed ()

void        kp_gui_destroy_widget_passed    (GtkWidget *widget,
                                             gpointer data);

widget :
data :

kp_gui_get_dates_for_view_type ()

void        kp_gui_get_dates_for_view_type  (GDate *date,
                                             KPViewModelType type,
                                             GDate **start,
                                             GDate **end,
                                             KPTrainingLog *log);

Get start and end date for the date and type.

date : Date to get start and end for
type : View type
start : Location that must store valid pointer to GDate
end : Location that must store valid pointer to GDate
log :

kp_get_combo_box_first_entry ()

gchar*      kp_get_combo_box_first_entry    (GtkComboBox *box);

Get the first item in the combo box.

box : A GtkComboBox
Returns : A newly-allocated string or NULL if the box is empty.

kp_get_icon_as_pixbuf ()

GdkPixbuf*  kp_get_icon_as_pixbuf           (const gchar *icon);

icon :
Returns :

kp_get_icon_as_image ()

GtkImage*   kp_get_icon_as_image            (const gchar *icon);

icon :
Returns :

kp_get_icon_filename ()

gchar*      kp_get_icon_filename            (const gchar *icon);

icon :
Returns :

kp_color_from_markup ()

void        kp_color_from_markup            (const gchar *markup,
                                             GdkColor *color);

markup :
color :

kp_color_str_to_markup ()

gchar*      kp_color_str_to_markup          (const gchar *color);

color :
Returns :

kp_color_to_markup ()

gchar*      kp_color_to_markup              (GdkColor *color);

color :
Returns :