GebrGuiHelpEditWidget class

GebrGuiHelpEditWidget class — A widget for editing rich text

Synopsis

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

struct              GebrGuiHelpEditWidget;
struct              GebrGuiHelpEditWidgetClass;
void                gebr_gui_help_edit_widget_set_editing
                                                        (GebrGuiHelpEditWidget *self,
                                                         gboolean editing);
void                gebr_gui_help_edit_widget_commit_changes
                                                        (GebrGuiHelpEditWidget *self);
gchar *             gebr_gui_help_edit_widget_get_content
                                                        (GebrGuiHelpEditWidget *self);
void                gebr_gui_help_edit_widget_set_content
                                                        (GebrGuiHelpEditWidget *self,
                                                         const gchar *content);
gboolean            gebr_gui_help_edit_widget_is_content_saved
                                                        (GebrGuiHelpEditWidget *self);
GtkWidget *         gebr_gui_help_edit_widget_get_web_view
                                                        (GebrGuiHelpEditWidget *self);
JSContextRef        gebr_gui_help_edit_widget_get_js_context
                                                        (GebrGuiHelpEditWidget *self);
GebrGuiHtmlViewerWidget *  gebr_gui_help_edit_widget_get_html_viewer
                                                        (GebrGuiHelpEditWidget *self);
void                gebr_gui_help_edit_widget_set_loaded
                                                        (GebrGuiHelpEditWidget *self);
const gchar *       gebr_gui_help_edit_widget_get_uri   (GebrGuiHelpEditWidget *self);
gboolean            gebr_gui_help_edit_widget_get_editing
                                                        (GebrGuiHelpEditWidget *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GtkVBox
                                       +----GebrGuiHelpEditWidget

Implemented Interfaces

GebrGuiHelpEditWidget implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

  "editing"                  gboolean              : Read / Write
  "saved"                    gboolean              : Read

Signals

  "commit-request"                                 : Run Last
  "content-loaded"                                 : Run Last

Description

A What You See Is What You Get rich text editor, made with WebKit and the JavaScript editor, CKEditor.

Details

struct GebrGuiHelpEditWidget

struct GebrGuiHelpEditWidget;

struct GebrGuiHelpEditWidgetClass

struct GebrGuiHelpEditWidgetClass {
	GtkVBoxClass parent_class;

	/* Abstract methods */
	gchar *		(*get_content)		(GebrGuiHelpEditWidget * self);
	void		(*set_content)		(GebrGuiHelpEditWidget * self, const gchar * content);
	void		(*commit_changes) (GebrGuiHelpEditWidget * self);
	gboolean (*is_content_saved) (GebrGuiHelpEditWidget * self);
	const gchar * (*get_uri)		(GebrGuiHelpEditWidget * self);
	void		(*preview_enter) (GebrGuiHelpEditWidget * self);

	/* Signals */
	void		(*commit_request) (GebrGuiHelpEditWidget * self);
	void		(*content_loaded) (GebrGuiHelpEditWidget * self);
};

gebr_gui_help_edit_widget_set_editing ()

void                gebr_gui_help_edit_widget_set_editing
                                                        (GebrGuiHelpEditWidget *self,
                                                         gboolean editing);

Sets the editor into edit mode or preview mode based on the value of editing parameter.

editing: Whether to edit or preview the help.


gebr_gui_help_edit_widget_commit_changes ()

void                gebr_gui_help_edit_widget_commit_changes
                                                        (GebrGuiHelpEditWidget *self);

Commit changes done in the Help until now.


gebr_gui_help_edit_widget_get_content ()

gchar *             gebr_gui_help_edit_widget_get_content
                                                        (GebrGuiHelpEditWidget *self);

Fetches the current state of the help edition.

Returns :

A newly allocated string, with the edited content of this help edit widget.

gebr_gui_help_edit_widget_set_content ()

void                gebr_gui_help_edit_widget_set_content
                                                        (GebrGuiHelpEditWidget *self,
                                                         const gchar *content);

Sets the content for this help edition session.

self :

The GebrGuiHelpEditWidget instance to have its content changed.

content :

The new content for this help edition.

gebr_gui_help_edit_widget_is_content_saved ()

gboolean            gebr_gui_help_edit_widget_is_content_saved
                                                        (GebrGuiHelpEditWidget *self);

self :

A GebrGuiHelpEditWidget instance.

Returns :

TRUE if the content is already saved, FALSE otherwise.

gebr_gui_help_edit_widget_get_web_view ()

GtkWidget *         gebr_gui_help_edit_widget_get_web_view
                                                        (GebrGuiHelpEditWidget *self);

Returns :

The WebKitWebView used to show the help edition.

gebr_gui_help_edit_widget_get_js_context ()

JSContextRef        gebr_gui_help_edit_widget_get_js_context
                                                        (GebrGuiHelpEditWidget *self);

Returns :

The JSContextRef from the WebKitWebView of this help edit widget.

gebr_gui_help_edit_widget_get_html_viewer ()

GebrGuiHtmlViewerWidget *  gebr_gui_help_edit_widget_get_html_viewer
                                                        (GebrGuiHelpEditWidget *self);

Returns :

The GebrGuiHtmlViewerWidget packed into this help edit widget.

gebr_gui_help_edit_widget_set_loaded ()

void                gebr_gui_help_edit_widget_set_loaded
                                                        (GebrGuiHelpEditWidget *self);

Sets the widget's state to STATE_LOADED.


gebr_gui_help_edit_widget_get_uri ()

const gchar *       gebr_gui_help_edit_widget_get_uri   (GebrGuiHelpEditWidget *self);

Returns :

the URI for the file being displayed by this help edit widget.

gebr_gui_help_edit_widget_get_editing ()

gboolean            gebr_gui_help_edit_widget_get_editing
                                                        (GebrGuiHelpEditWidget *self);

The GebrGuiHelpEditWidget can be in edit mode or preview mode.

Returns :

TRUE if self is in editing mode, FALSE otherwise.

Property Details

The "editing" property

  "editing"                  gboolean              : Read / Write

Whether editing the help or previewing it.

Default value: TRUE


The "saved" property

  "saved"                    gboolean              : Read

Whether the help is saved or not.

Default value: FALSE

Signal Details

The "commit-request" signal

void                user_function                      (GebrGuiHelpEditWidget *arg0,
                                                        gpointer               user_data)      : Run Last

user_data :

user data set when the signal handler was connected.

The "content-loaded" signal

void                user_function                      (GebrGuiHelpEditWidget *arg0,
                                                        gpointer               user_data)      : Run Last

user_data :

user data set when the signal handler was connected.

See Also

GebrGuiHelpEditWindow