GebrGuiHelpEditWindow class

GebrGuiHelpEditWindow class — A window presenting a toolbar with actions for the help edit widget

Synopsis

#include <libgebr/gui/gebr-gui-help-edit-window.h>

#define             GEBR_GUI_HELP_EDIT_WINDOW_MENU_BAR_NAME
#define             GEBR_GUI_HELP_EDIT_WINDOW_MENU_BAR_MARK
#define             GEBR_GUI_HELP_EDIT_WINDOW_TOOL_BAR_NAME
#define             GEBR_GUI_HELP_EDIT_WINDOW_TOOL_BAR_MARK
struct              GebrGuiHelpEditWindow;
struct              GebrGuiHelpEditWindowClass;
GtkWidget *         gebr_gui_help_edit_window_new       (GebrGuiHelpEditWidget *help_edit_widget);
gboolean            gebr_gui_help_edit_window_quit      (GebrGuiHelpEditWindow *self);
void                gebr_gui_help_edit_window_set_has_menu_bar
                                                        (GebrGuiHelpEditWindow *self,
                                                         gboolean has_menu_bar);
void                gebr_gui_help_edit_window_set_auto_save
                                                        (GebrGuiHelpEditWindow *self,
                                                         gboolean auto_save);
GtkUIManager *      gebr_gui_help_edit_window_get_ui_manager
                                                        (GebrGuiHelpEditWindow *self);
const gchar *       gebr_gui_help_edit_window_get_menu_bar_path
                                                        (GebrGuiHelpEditWindow *self);
const gchar *       gebr_gui_help_edit_window_get_file_menu_path
                                                        (GebrGuiHelpEditWindow *self);
const gchar *       gebr_gui_help_edit_window_get_edit_menu_path
                                                        (GebrGuiHelpEditWindow *self);
const gchar *       gebr_gui_help_edit_window_get_menu_mark
                                                        (GebrGuiHelpEditWindow *self);
const gchar *       gebr_gui_help_edit_window_get_tool_bar_path
                                                        (GebrGuiHelpEditWindow *self);
const gchar *       gebr_gui_help_edit_window_get_tool_bar_mark
                                                        (GebrGuiHelpEditWindow *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GebrGuiHelpEditWindow

Implemented Interfaces

GebrGuiHelpEditWindow implements AtkImplementorIface and GtkBuildable.

Properties

  "auto-save"                gboolean              : Read / Write
  "has-menu-bar"             gboolean              : Read / Write
  "help-edit-widget"         gpointer              : Read / Write / Construct Only

Description

This widget packs a GebrGuiHelpEditWidget for editing a help string. It may or may not have a Refresh button, depending on which constructor you use to instanciate this class.

Details

GEBR_GUI_HELP_EDIT_WINDOW_MENU_BAR_NAME

#define GEBR_GUI_HELP_EDIT_WINDOW_MENU_BAR_NAME "help_edit_window_menu_bar"

GEBR_GUI_HELP_EDIT_WINDOW_MENU_BAR_MARK

#define GEBR_GUI_HELP_EDIT_WINDOW_MENU_BAR_MARK "help_edit_window_menu_bar_place_holder"

GEBR_GUI_HELP_EDIT_WINDOW_TOOL_BAR_NAME

#define GEBR_GUI_HELP_EDIT_WINDOW_TOOL_BAR_NAME "help_edit_window_tool_bar"

GEBR_GUI_HELP_EDIT_WINDOW_TOOL_BAR_MARK

#define GEBR_GUI_HELP_EDIT_WINDOW_TOOL_BAR_MARK "help_edit_window_tool_bar_place_holder"

struct GebrGuiHelpEditWindow

struct GebrGuiHelpEditWindow;

struct GebrGuiHelpEditWindowClass

struct GebrGuiHelpEditWindowClass {
	GtkWindowClass parent_class;

	/* Signals */
	void (*refresh_requested) (GebrGuiHelpEditWindow *self, GString *help);
};

gebr_gui_help_edit_window_new ()

GtkWidget *         gebr_gui_help_edit_window_new       (GebrGuiHelpEditWidget *help_edit_widget);

Creates a new window containing a tool bar and a menu bar, which you can modify using the GtkUIManager.

help_edit_widget :

A GebrGuiHelpEditWidget to perform the help edition.

gebr_gui_help_edit_window_quit ()

gboolean            gebr_gui_help_edit_window_quit      (GebrGuiHelpEditWindow *self);

Closes window, showing a message dialog if the content has uncommitted changes. This function will not destroy this help edit window if the user choses cancel in the confirmation dialog. In this case, FALSE is returned.

window :

a GebrGuiHelpEditWindow

Returns :

TRUE if the window was destroyed, FALSE otherwise.

gebr_gui_help_edit_window_set_has_menu_bar ()

void                gebr_gui_help_edit_window_set_has_menu_bar
                                                        (GebrGuiHelpEditWindow *self,
                                                         gboolean has_menu_bar);

gebr_gui_help_edit_window_set_auto_save ()

void                gebr_gui_help_edit_window_set_auto_save
                                                        (GebrGuiHelpEditWindow *self,
                                                         gboolean auto_save);

gebr_gui_help_edit_window_get_ui_manager ()

GtkUIManager *      gebr_gui_help_edit_window_get_ui_manager
                                                        (GebrGuiHelpEditWindow *self);

window :

this window. Returns: A GtkUIManager.

gebr_gui_help_edit_window_get_menu_bar_path ()

const gchar *       gebr_gui_help_edit_window_get_menu_bar_path
                                                        (GebrGuiHelpEditWindow *self);

gebr_gui_help_edit_window_get_file_menu_path ()

const gchar *       gebr_gui_help_edit_window_get_file_menu_path
                                                        (GebrGuiHelpEditWindow *self);

gebr_gui_help_edit_window_get_edit_menu_path ()

const gchar *       gebr_gui_help_edit_window_get_edit_menu_path
                                                        (GebrGuiHelpEditWindow *self);

gebr_gui_help_edit_window_get_menu_mark ()

const gchar *       gebr_gui_help_edit_window_get_menu_mark
                                                        (GebrGuiHelpEditWindow *self);

gebr_gui_help_edit_window_get_tool_bar_path ()

const gchar *       gebr_gui_help_edit_window_get_tool_bar_path
                                                        (GebrGuiHelpEditWindow *self);

gebr_gui_help_edit_window_get_tool_bar_mark ()

const gchar *       gebr_gui_help_edit_window_get_tool_bar_mark
                                                        (GebrGuiHelpEditWindow *self);

Property Details

The "auto-save" property

  "auto-save"                gboolean              : Read / Write

Whether to automatic save.

Default value: FALSE


The "has-menu-bar" property

  "has-menu-bar"             gboolean              : Read / Write

Whether to show the menu bar.

Default value: TRUE


The "help-edit-widget" property

  "help-edit-widget"         gpointer              : Read / Write / Construct Only

The GebrGuiHelpEdit widget.

See Also

GebrGuiHelpEditWidget