GebrGuiHtmlViewerWidget

GebrGuiHtmlViewerWidget

Functions

Signals

void navigation-requested Run Last
void print-requested Run Last
void title-ready Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── GtkVBox
                            ╰── GebrGuiHtmlViewerWidget

Implemented Interfaces

GebrGuiHtmlViewerWidget implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Description

Functions

GebrGuiHtmlViewerCustomTab ()

GtkWidget *
(*GebrGuiHtmlViewerCustomTab) (GebrGuiHtmlViewerWidget *self);

gebr_gui_html_viewer_widget_new ()

GtkWidget *
gebr_gui_html_viewer_widget_new ();

Creates a new html viewer widget.


gebr_gui_html_viewer_widget_print ()

void
gebr_gui_html_viewer_widget_print (GebrGuiHtmlViewerWidget *self);

Prints the content of a html viewer widget


gebr_gui_html_viewer_show_search_bar ()

void
gebr_gui_html_viewer_show_search_bar (GebrGuiHtmlViewerWidget *self);

Show a search bar if it is not visible, otherwise, hide the bar


gebr_gui_html_viewer_widget_show_html ()

void
gebr_gui_html_viewer_widget_show_html (GebrGuiHtmlViewerWidget *self,
                                       const gchar *content);

Show the html content


gebr_gui_html_viewer_widget_generate_links ()

void
gebr_gui_html_viewer_widget_generate_links
                               (GebrGuiHtmlViewerWidget *self,
                                GebrGeoXmlObject *object);

Schedules the generation of the links for object , which happens when the next call to gebr_gui_html_viewer_widget_show_html() is done.

Parameters

widget

The HTML viewer widget

 

object

A GebrGeoXmlObject for generating the links

 

gebr_gui_html_viewer_widget_set_custom_tab ()

void
gebr_gui_html_viewer_widget_set_custom_tab
                               (GebrGuiHtmlViewerWidget *self,
                                const gchar *label,
                                GebrGuiHtmlViewerCustomTab callback);

Create the custom print tab

Parameters

widget

an html viewer widget

 

label

Name the new custom tab

 

widget

The widget to attach to the print dialog, as the only custom tab

 

gebr_gui_html_viewer_widget_get_html ()

const gchar *
gebr_gui_html_viewer_widget_get_html (GebrGuiHtmlViewerWidget *self);

Retrieves the content shown by this HTML viewer widget. Notice that this may not be the same HTML set with gebr_gui_html_viewer_widget_show_html(), since the string is processed before shown.

Parameters

widget

an html viewer widget

 

Returns

the HTML content shown by this widget. The string is owned by GêBR and should not be modified or freed.


gebr_gui_html_viewer_widget_get_related_object ()

GebrGeoXmlObject *
gebr_gui_html_viewer_widget_get_related_object
                               (GebrGuiHtmlViewerWidget *self);

Returns

the GebrGeoXmlObject associated with the help being shown by this widget. If the help shown has nothing to do with any object, than NULL is returned.


gebr_gui_html_viewer_widget_load_anchor ()

void
gebr_gui_html_viewer_widget_load_anchor
                               (GebrGuiHtmlViewerWidget *self,
                                gint anchor);

Reload html to move view to anchor

Parameters

anchor

The anchor to go

 

gebr_gui_html_viewer_widget_set_is_menu ()

void
gebr_gui_html_viewer_widget_set_is_menu
                               (GebrGuiHtmlViewerWidget *self,
                                gboolean is_menu);

Parameters

is_menu

Flag to set if help is a menu

 

Types and Values

struct GebrGuiHtmlViewerWidget

struct GebrGuiHtmlViewerWidget;

struct GebrGuiHtmlViewerWidgetClass

struct GebrGuiHtmlViewerWidgetClass {
	GtkVBoxClass parent_class;

	/* Signals */
	void (*title_ready) (GebrGuiHtmlViewerWidget * self, const gchar * title);
	void (*print_requested) (GebrGuiHtmlViewerWidget * self);
	void (*navigation_requested) (GebrGuiHtmlViewerWidget * self);
};

Signal Details

The “navigation-requested” signal

void
user_function (GebrGuiHtmlViewerWidget *arg0,
               gpointer                 user_data)

Parameters

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “print-requested” signal

void
user_function (GebrGuiHtmlViewerWidget *arg0,
               gpointer                 user_data)

Parameters

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “title-ready” signal

void
user_function (GebrGuiHtmlViewerWidget *widget,
               gchar                   *title,
               gpointer                 user_data)

This signal is fired when the title is ready to be set. The title is passed by parameter title , and its value may depend on context. If this viewer is showing the help of a geoxml-menu, the title is the same as the menu. Otherwise, the title is defined by the <title> tag inside the Html.

Parameters

widget

This GebrGuiHtmlViewerWidget

 

title

The title.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last