include/alp/browserview.h File Reference


Detailed Description

ACCESS Linux Platform GTK Browser View Library API.

#include <gdk/gdk.h>
#include <gtk/gtkvbox.h>
#include <alp/sysclass.h>
#include <alp/types.h>

Go to the source code of this file.

Data Structures

struct  _AlpBrowserView
struct  _AlpBrowserViewClass
struct  AlpBrowserViewFocusTargetInfo

BrowserView Display Modes

See alp_browser_view_new().

#define ALP_BROWSER_VIEW_DISPLAY_MODE_DESKTOP   1
#define ALP_BROWSER_VIEW_DISPLAY_MODE_SMART_FIT   3
#define ALP_BROWSER_VIEW_DISPLAY_MODE_TEXT   2
typedef guint AlpBrowserViewDisplayMode

BrowserView Focus Target Types

These input form type values are used within the AlpBrowserViewFocusTargetInfo data structure, which is obtained with alp_browser_view_get_target_info().

#define ALP_BROWSER_VIEW_TARGET_ANCHO_HTTP   1
#define ALP_BROWSER_VIEW_TARGET_ANCHO_MAILTO   15
#define ALP_BROWSER_VIEW_TARGET_ANCHO_TEL   2
#define ALP_BROWSER_VIEW_TARGET_ANCHO_TELAV   3
#define ALP_BROWSER_VIEW_TARGET_IFRAME   16
#define ALP_BROWSER_VIEW_TARGET_IMAGE   4
#define ALP_BROWSER_VIEW_TARGET_INPUT_BUTTON   5
#define ALP_BROWSER_VIEW_TARGET_INPUT_CHECKBOX   6
#define ALP_BROWSER_VIEW_TARGET_INPUT_FILE   7
#define ALP_BROWSER_VIEW_TARGET_INPUT_PASSWORD   8
#define ALP_BROWSER_VIEW_TARGET_INPUT_RADIO   9
#define ALP_BROWSER_VIEW_TARGET_INPUT_RESET   10
#define ALP_BROWSER_VIEW_TARGET_INPUT_SELECT   11
#define ALP_BROWSER_VIEW_TARGET_INPUT_SUBMIT   12
#define ALP_BROWSER_VIEW_TARGET_INPUT_TEXT   13
#define ALP_BROWSER_VIEW_TARGET_INPUT_TEXTAREA   14
typedef guint AlpBrowserViewFocusTargetType

BrowserView Library initialization error codes

Used by: each function in this API that returns a value from the following list.

#define ALP_BROWSERVIEW_ERROR_CANTOPEN   ((alp_status_t) (ALP_CLASS_BROWSERVIEW | 0x00070000))
#define ALP_BROWSERVIEW_ERROR_GENERIC   ((alp_status_t) (ALP_CLASS_BROWSERVIEW | 0x00080000))
#define ALP_BROWSERVIEW_ERROR_INUSE   ((alp_status_t) (ALP_CLASS_BROWSERVIEW | 0x00020000))
#define ALP_BROWSERVIEW_ERROR_INVALIDPARAM   ((alp_status_t) (ALP_CLASS_BROWSERVIEW | 0x00040000))
#define ALP_BROWSERVIEW_ERROR_NOTFOUND   ((alp_status_t) (ALP_CLASS_BROWSERVIEW | 0x00050000))
#define ALP_BROWSERVIEW_ERROR_NOTINITIALIZED   ((alp_status_t) (ALP_CLASS_BROWSERVIEW | 0x00060000))
#define ALP_BROWSERVIEW_ERROR_OUTOFMEMORY   ((alp_status_t) (ALP_CLASS_BROWSERVIEW | 0x00030000))
#define ALP_BROWSERVIEW_ERROR_SUCCESS   ((alp_status_t) (ALP_CLASS_BROWSERVIEW | 0x00010000))

BrowserView Scrolling Directions

Used as a parameter of alp_browser_view_can_scroll() to query scroll status.

#define AlpBrowserViewDirDown   4
#define AlpBrowserViewDirLeft   1
#define AlpBrowserViewDirRight   2
#define AlpBrowserViewDirUp   3
typedef guint AlpBrowserViewScrollDirection

BrowserView font size

Used as a parameter of alp_browser_view_set_font_size().

#define AlpBrowserViewFontSizeLarge   3
#define AlpBrowserViewFontSizeNormal   2
#define AlpBrowserViewFontSizeSmall   1
typedef guint AlpBrowserViewFontSize

BrowserView Submit Form Methods

Used by alp_browser_view_submit_form_callback, to describe the submit method to use.

#define AlpBrowserViewHttpMethodGet   1
#define AlpBrowserViewHttpMethodPost   2
typedef guint AlpBrowserViewSubmitFormMethod

BrowserView Progress Status

The progress information can be obtained by setting up a notification callback. See alp_browser_view_set_progress_callback(), and see alp_browser_view_progress_callback for reference.

#define AlpBrowserViewInputFormatCheckFailed   8
#define AlpBrowserViewProgressAuthenticationDone   7
#define AlpBrowserViewProgressAuthenticationFailed   6
#define AlpBrowserViewProgressAuthenticationStart   5
#define AlpBrowserViewProgressBusy   2
#define AlpBrowserViewProgressDone   1
#define AlpBrowserViewProgressError   4
#define AlpBrowserViewProgressFileOperationError   10
#define AlpBrowserViewProgressHTTPError   9
#define AlpBrowserViewProgressOutOfMemory   3
typedef guint AlpBrowserViewProgressStatus

The BrowserView flag of focus move out

Used by alp_browser_view_set_focus_move_out_flag

enum  { AlpBrowserViewFocusMoveOutLeft = 1, AlpBrowserViewFocusMoveOutRight = 2, AlpBrowserViewFocusMoveOutUp = 4, AlpBrowserViewFocusMoveOutDown = 8 }

Defines

#define ALP_BROWSER_VIEW(obj)   GTK_CHECK_CAST (obj, alp_browser_view_get_type (), AlpBrowserView)
#define ALP_BROWSER_VIEW_CLASS(klass)   GTK_CHECK_CLASS_CAST (klass, alp_browser_view_get_type (), AlpBrowserViewClass)
#define ALP_IS_BROWSER_VIEW(obj)   GTK_CHECK_TYPE (obj, alp_browser_view_get_type ())
#define ALP_TYPE_BROWSERVIEW   (alp_browser_view_get_type())

Typedefs

typedef gboolean alp_browser_view_authenticate_callback (GtkWidget *widget, gchar *url, gchar **userName, gchar **password)
typedef gboolean alp_browser_view_link_selection_callback (GtkWidget *widget, gchar *url, void *callBackData)
typedef void alp_browser_view_progress_callback (GtkWidget *widget, gchar *url, AlpBrowserViewProgressStatus status)
typedef gboolean alp_browser_view_scan_hyperlink_callback (GtkWidget *widget, gchar *buffer, guint length, guint *patternStart, gint *patternEnd, gint *patternType)
typedef gboolean alp_browser_view_submit_form_callback (GtkWidget *widget, gchar *url, AlpBrowserViewSubmitFormMethod method, gchar *postData, void *callBackData)
typedef _AlpBrowserView AlpBrowserView
typedef _AlpBrowserViewClass AlpBrowserViewClass
typedef void * AlpBrowserViewContent

Functions

alp_status_t alp_browser_view_abort (GtkWidget *widget)
alp_status_t alp_browser_view_add_binary_data (GtkWidget *widget, AlpBrowserViewContent *content, gchar *url, gchar *mimeType, void *data, guint dataSize)
alp_status_t alp_browser_view_add_text_data (GtkWidget *widget, AlpBrowserViewContent *content, gchar *url, gchar *mimeType, gchar *charset, void *data, guint dataSize)
alp_status_t alp_browser_view_can_scroll (GtkWidget *widget, AlpBrowserViewScrollDirection direction, gboolean *canScroll)
alp_status_t alp_browser_view_clear_screen (GtkWidget *widget)
alp_status_t alp_browser_view_create_content_object (GtkWidget *widget, AlpBrowserViewContent **content)
alp_status_t alp_browser_view_destroy (GtkWidget *widget)
alp_status_t alp_browser_view_destroy_content_object (GtkWidget *widget, AlpBrowserViewContent *content)
alp_status_t alp_browser_view_find_text (GtkWidget *widget, gchar *searchString, gboolean wrapSearch, gint searchDirection)
alp_status_t alp_browser_view_get_target_info (GtkWidget *widget, AlpBrowserViewFocusTargetInfo *targetInfo)
alp_status_t alp_browser_view_get_text_selection (GtkWidget *widget, gchar **selectedText)
GType alp_browser_view_get_type ()
alp_status_t alp_browser_view_get_vertical_scroll_position (GtkWidget *widget, guint *position)
alp_status_t alp_browser_view_library_finalize (void)
alp_status_t alp_browser_view_library_initialize (void)
alp_status_t alp_browser_view_library_set_cnc_profile (const gchar *profile_name)
GtkWidget * alp_browser_view_new (GtkAllocation *rect, AlpBrowserViewDisplayMode mode, gchar *url, alp_status_t *err)
alp_status_t alp_browser_view_redraw_screen (GtkWidget *widget)
alp_status_t alp_browser_view_refresh (GtkWidget *widget)
alp_status_t alp_browser_view_render_data (GtkWidget *widget, AlpBrowserViewContent *content)
alp_status_t alp_browser_view_select_all_text (GtkWidget *widget)
alp_status_t alp_browser_view_set_authenticate_callback (GtkWidget *widget, alp_browser_view_authenticate_callback *callBack)
alp_status_t alp_browser_view_set_focus_move_out_flag (GtkWidget *widget, gint flag)
alp_status_t alp_browser_view_set_font_size (GtkWidget *widget, AlpBrowserViewFontSize value)
alp_status_t alp_browser_view_set_hyperlink_scan_callback (GtkWidget *widget, alp_browser_view_scan_hyperlink_callback *callBack)
alp_status_t alp_browser_view_set_link_selection_callback (GtkWidget *widget, alp_browser_view_link_selection_callback *callBack, void *callBackData)
alp_status_t alp_browser_view_set_progress_callback (GtkWidget *widget, alp_browser_view_progress_callback *notifyCallBack)
alp_status_t alp_browser_view_set_submit_callback (GtkWidget *widget, alp_browser_view_submit_form_callback *callBack, void *callBackData)
alp_status_t alp_browser_view_set_vertical_scroll_position (GtkWidget *widget, guint newPosition)


Generated on Wed Jul 30 07:06:39 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.