application: gURLChecker Reference Manual

application

application — Manage some general application work.

Functions

void	uc_application_main_tree_apply_filters ()
void	uc_application_reset_menu_protocols ()
void	uc_application_reset_menu_status ()
void	uc_application_reset_menu_types ()
UCURLsUserActions *	uc_application_get_urls_user_action ()
UCURLsUserActions *	uc_application_get_urls_user_action_by_value ()
void	uc_application_urls_user_actions_init ()
gboolean	uc_application_cookie_warning_dialog_show ()
void	uc_application_w3c_validate ()
void	uc_application_buffer_show ()
void	uc_application_build_projects_treeview ()
gchar *	uc_application_input_dialog ()
gchar *	uc_application_input_file_dialog ()
void	uc_application_view_bad_extensions_dialog_show ()
void	uc_application_set_status_bar ()
void	uc_application_open_project_dialog_show ()
gboolean	uc_application_project_information_dialog_show ()
void	uc_application_progress_dialog_set_modal ()
gboolean	uc_application_treeview_get_selected_iter ()
void	uc_application_build_url_treeview ()
void	uc_application_main_tree_display_all ()
void	uc_application_main_tree_collapse_all ()
void	uc_application_main_tree_expand_all ()
void	uc_application_main_tree_display_branch ()
void	uc_application_display_search_message ()
gint	uc_application_dialog_yes_no_show ()
void	uc_application_search_dialog_show ()
void	uc_application_new_search_dialog_show ()
void	uc_application_add_filter_directory_add ()
void	uc_application_add_filter_domain_add ()
void	uc_application_add_filter_domain_remove ()
void	uc_application_add_filter_directory_remove ()
void	uc_application_add_filter_directory_dialog_show ()
void	uc_application_page_information_dialog_show ()
void	uc_application_display_state_message ()
void	uc_application_display_informations ()
void	uc_application_treeview_activate_popup ()
void	uc_application_view_similar_links_dialog_show ()
void	uc_application_new_instance_launch ()
void	uc_application_launch_web_browser ()
void	uc_application_menu_set_sensitive_all ()
void	uc_application_proxy_frame_control_sensitive ()
void	uc_application_make_paths ()
void	uc_application_remove_paths ()
void	uc_application_view_source_dialog_show ()
void	uc_application_view_image_dialog_show ()
void	uc_application_dialog_show ()
void	uc_application_globals_init ()
void	uc_application_init ()
gboolean	uc_application_quit ()
void	uc_application_draw_main_frames ()
void	uc_application_search_get_data ()
void	uc_application_get_bookmarks_project_data ()
void	uc_application_new_web_dialog_show ()
void	uc_application_new_local_file_dialog_show ()
void	uc_application_new_bookmarks_dialog_show ()
void	uc_application_open_dialog_show ()
void	uc_application_about_dialog_show ()
void	uc_application_progress_dialog_show ()
void	uc_application_settings_dialog_show ()
gboolean	uc_application_settings_get_data ()
void	uc_application_status_code_properties_init ()
UCStatusCode *	uc_application_get_status_code_properties ()
gboolean	uc_application_project_get_data ()
gboolean	uc_application_auth_dialog_show ()

Types and Values

struct

UCURLsUserActions

Description

Functions

uc_application_main_tree_apply_filters ()

void
uc_application_main_tree_apply_filters
                               (const gchar *wname);

uc_application_reset_menu_protocols ()

void
uc_application_reset_menu_protocols (void);

uc_application_reset_menu_status ()

void
uc_application_reset_menu_status (void);

uc_application_reset_menu_types ()

void
uc_application_reset_menu_types (void);

uc_application_get_urls_user_action ()

UCURLsUserActions *
uc_application_get_urls_user_action (gchar *key);

Get a action by its key.

uc_application_get_urls_user_action_by_value ()

UCURLsUserActions *
uc_application_get_urls_user_action_by_value
                               (gchar *value);

Get a action by its value.

uc_application_urls_user_actions_init ()

void
uc_application_urls_user_actions_init (void);

This function load the actions tp associate with bad URLs.

uc_application_cookie_warning_dialog_show ()

gboolean
uc_application_cookie_warning_dialog_show
                               (const gchar *server,
                                const gchar *page,
                                const gchar *label,
                                gchar **name,
                                gchar **value,
                                gchar **path,
                                gchar **expires,
                                const UCCookiesAction action);

Dialog for accepting/refusing a cookie.

Parameters

server	hostname.
page	page name.
label	dialog's label.
name	cookie's name.
value	cookie's value.
path	cookie's path.
expires	expirationdate.
action	cookies action.

Returns

TRUE if the cookie must be accepted.

uc_application_w3c_validate ()

void
uc_application_w3c_validate (void);

uc_application_buffer_show ()

void
uc_application_buffer_show (const gchar *title,
                            const gchar *message);

uc_application_build_projects_treeview ()

void
uc_application_build_projects_treeview
                               (void);

uc_application_input_dialog ()

gchar *
uc_application_input_dialog (const gchar *title,
                             const gchar *text);

Show a prompt popup.

Parameters

title	title of the popup.
text	The text to display.

Returns

The user string. This is a newly allocated string.

uc_application_input_file_dialog ()

gchar *
uc_application_input_file_dialog (const gchar *title,
                                  const gchar *text);

Show a prompt popup to input a filename or directory.

Parameters

title	Title of the popup.
text	The text to display.

Returns

The user string. This is a newly allocated string.

uc_application_view_bad_extensions_dialog_show ()

void
uc_application_view_bad_extensions_dialog_show
                               (void);

Show bad extensions dialog.

uc_application_set_status_bar ()

void
uc_application_set_status_bar (const gfloat progress,
                               const gchar *msg);

Refresh application status bar.

Parameters

progress	0, or a value if we want progress bar on the status bar.
msg	message to display in satus bar.

uc_application_open_project_dialog_show ()

void
uc_application_open_project_dialog_show
                               (void);

Show the open project dialog.

uc_application_project_information_dialog_show ()

gboolean
uc_application_project_information_dialog_show
                               (void);

Show the project properties dialog.

Returns

TRUE if project must be saved.

uc_application_progress_dialog_set_modal ()

void
uc_application_progress_dialog_set_modal
                               (const gboolean modal);

uc_application_treeview_get_selected_iter ()

gboolean
uc_application_treeview_get_selected_iter
                               (const GtkTreeView *tv,
                                GtkTreeIter *iter);

set the iterator for the current selection in a given treeview.

Parameters

tv	Tree view to work with.
iter	Iterater to fill.

Returns

TRUE if it has filled the given iter with selection.

uc_application_build_url_treeview ()

void
uc_application_build_url_treeview (void);

Build all needed elements for the main URL tree view.

uc_application_main_tree_display_all ()

void
uc_application_main_tree_display_all (void);

Display the whole list of checked url in the main url treeview.

uc_application_main_tree_collapse_all ()

void
uc_application_main_tree_collapse_all (void);

Collapse the main url treeview.

uc_application_main_tree_expand_all ()

void
uc_application_main_tree_expand_all (void);

Expand the main url treeview.

uc_application_main_tree_display_branch ()

void
uc_application_main_tree_display_branch
                               (const UCLinkProperties *prop);

uc_application_display_search_message ()

void
uc_application_display_search_message (const guint label_pos,
                                       const gchar *message);

Display messages in the progess dialog during the search.

Parameters

label_pos	Position of the given message.
message	Message to display.

uc_application_dialog_yes_no_show ()

gint
uc_application_dialog_yes_no_show (const gchar *message,
                                   const GtkMessageType msg_type);

Print a yes/no choice dialog.

Parameters

message	The message to display.
msg_type	Type of the message.

Returns

TRUE if user clicked on the OK button.

uc_application_search_dialog_show ()

void
uc_application_search_dialog_show (void);

Show the search dialog.

uc_application_new_search_dialog_show ()

void
uc_application_new_search_dialog_show (void);

Show the search dialog.

uc_application_add_filter_directory_add ()

void
uc_application_add_filter_directory_add
                               (void);

Add a directory filter.

uc_application_add_filter_domain_add ()

void
uc_application_add_filter_domain_add (void);

Add a domain filter.

uc_application_add_filter_domain_remove ()

void
uc_application_add_filter_domain_remove
                               (void);

Remove a domain filter.

uc_application_add_filter_directory_remove ()

void
uc_application_add_filter_directory_remove
                               (void);

Remove a directory filter.

uc_application_add_filter_directory_dialog_show ()

void
uc_application_add_filter_directory_dialog_show
                               (void);

uc_application_page_information_dialog_show ()

void
uc_application_page_information_dialog_show
                               (void);

Show the properties dialog.

uc_application_display_state_message ()

void
uc_application_display_state_message (const guint label_pos,
                                      const gchar *message);

Display messages in the progess dialog during the check process

Parameters

label_pos	Position of the given message.
message	Message to display.

uc_application_display_informations ()

void
uc_application_display_informations (GtkTreeView *treeview);

Search the header of a given url in the urls list to display it.

Parameters

treeview

Tree view to work with.

uc_application_treeview_activate_popup ()

void
uc_application_treeview_activate_popup
                               (GdkEventButton *event);

Display the treview popup menu.

Parameters

event

Event.

uc_application_view_similar_links_dialog_show ()

void
uc_application_view_similar_links_dialog_show
                               (void);

Show similar links dialog.

uc_application_new_instance_launch ()

void
uc_application_new_instance_launch (void);

Launch a new instance of gURLChecker.

uc_application_launch_web_browser ()

void
uc_application_launch_web_browser (const gchar *url);

Launch a web browser to view the selected url

Parameters

url

URL to pass to the web browser.

uc_application_menu_set_sensitive_all ()

void
uc_application_menu_set_sensitive_all (const gchar *name,
                                       const gboolean val);

uc_application_proxy_frame_control_sensitive ()

void
uc_application_proxy_frame_control_sensitive
                               (void);

uc_application_make_paths ()

void
uc_application_make_paths (void);

Create the directories needed by gURLChecker.

uc_application_remove_paths ()

void
uc_application_remove_paths (void);

Remove all application paths

uc_application_view_source_dialog_show ()

void
uc_application_view_source_dialog_show
                               (void);

Show view source dialog.

uc_application_view_image_dialog_show ()

void
uc_application_view_image_dialog_show (void);

Show view image dialog.

uc_application_dialog_show ()

void
uc_application_dialog_show (const gchar *message,
                            const GtkMessageType msg_type);

Print a alert box.

Parameters

message	The message to display.
msg_type	Type of the message.

uc_application_globals_init ()

void
uc_application_globals_init (void);

Initialisation of all globals.

uc_application_init ()

void
uc_application_init (gchar *url,
                     gchar *auth_user,
                     gchar *auth_password,
                     gboolean no_urls_args);

gURLChecker initialization.

Parameters

url	the command line URL, or `NULL`
auth_user	user for authentication.
auth_password	password for authentication.
no_urls_args	if `TRUE`, do not check URL with arguments

uc_application_quit ()

gboolean
uc_application_quit (void);

Do a clean application exit.

Returns

~TRUE if we must quit application.

uc_application_draw_main_frames ()

void
uc_application_draw_main_frames (void);

Draw the two principals main frames for displaying urls list and headers.

uc_application_search_get_data ()

void
uc_application_search_get_data (void);

Retreive the string to search and the search properties.

uc_application_get_bookmarks_project_data ()

void
uc_application_get_bookmarks_project_data
                               (void);

Retrieving bookmarks file to check.

uc_application_new_web_dialog_show ()

void
uc_application_new_web_dialog_show (void);

Show the new web project dialog box.

uc_application_new_local_file_dialog_show ()

void
uc_application_new_local_file_dialog_show
                               (void);

Show the new local file project dialog box.

uc_application_new_bookmarks_dialog_show ()

void
uc_application_new_bookmarks_dialog_show
                               (void);

Show the new bookmarks project dialog box.

uc_application_open_dialog_show ()

void
uc_application_open_dialog_show (void);

uc_application_about_dialog_show ()

void
uc_application_about_dialog_show (void);

Show the about box.

uc_application_progress_dialog_show ()

void
uc_application_progress_dialog_show ();

Show the progess dialog.

uc_application_settings_dialog_show ()

void
uc_application_settings_dialog_show (void);

Show the settings dialog box.

uc_application_settings_get_data ()

gboolean
uc_application_settings_get_data (void);

Retrieve user input data settings.

Returns

TRUE if all inputs are ok.

uc_application_status_code_properties_init ()

void
uc_application_status_code_properties_init
                               (void);

This function load the properties to associate with a server status code.

uc_application_get_status_code_properties ()

UCStatusCode *
uc_application_get_status_code_properties
                               (const gchar *status_code);

Return properties for a given status code.

Parameters

status_code

Status code to work with.

Returns

UCStatusCode propertie node associated with the given status code.

uc_application_project_get_data ()

gboolean
uc_application_project_get_data (const UCProjectType type);

Retrieving url to check and some check properties.

Parameters

type

FIXME.

Returns

TRUE if data input is ok.

uc_application_auth_dialog_show ()

gboolean
uc_application_auth_dialog_show (const gchar *title,
                                 const gchar *host);

Show the basic authentication dialog.

Parameters

title

string returned by the remote host when requested authentication.

Returns

TRUE if both user and password have been entered.

Types and Values

struct UCURLsUserActions

struct UCURLsUserActions {
  gchar *id;
  gchar *label;
};

Structure to store bad URLs actions.

Members

gchar *`id`;	Index of the action.
gchar *`label`;	Action label.