erbrowser/src/mozilla_api.h File Reference

browser - API for retrieving info on the loaded XHTML page More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	NEXT_LINK   0
#define	PREVIOUS_LINK   1
Enumerations
enum	direction_t { pageUp_t, pageDown_t }
Functions
gboolean	mozilla_get_page_type (GtkMozEmbed *b, char **type)
gboolean	mozilla_save (GtkMozEmbed *b, gchar *file_name, gint all)
gboolean	mozilla_next_link (GtkMozEmbed *b)
gboolean	mozilla_previous_link (GtkMozEmbed *b)
gboolean	mozilla_handle_link (GtkMozEmbed *b)
gboolean	mozilla_overview_page (GtkMozEmbed *b)
gboolean	mozilla_next_page (GtkMozEmbed *b)
gboolean	mozilla_previous_page (GtkMozEmbed *b)
gboolean	mozilla_alt_page (GtkMozEmbed *b)
gboolean	mozilla_back (GtkMozEmbed *b)
gboolean	mozilla_scrollable (direction_t direction, GtkMozEmbed *b)
gboolean	mozilla_scroll (int count, GtkMozEmbed *b)
gboolean	mozilla_zoom (GtkMozEmbed *b, float size)
gint	mozilla_determine_page_offset (GtkMozEmbed *b)
char *	mozilla_uri_to_path (const char *uri)
int	raw_url_decode (char *str, int len)

---

Detailed Description

browser - API for retrieving info on the loaded XHTML page

<File description>="">

Definition in file mozilla_api.h.

---

Define Documentation

#define NEXT_LINK   0

Definition at line 34 of file mozilla_api.h.

#define PREVIOUS_LINK   1

Definition at line 35 of file mozilla_api.h.

---

Enumeration Type Documentation

enum direction_t

Enumerator:

pageUp_t
pageDown_t

Definition at line 37 of file mozilla_api.h.

{
        pageUp_t,
        pageDown_t,
} direction_t;

---

Function Documentation

gboolean mozilla_alt_page

(

GtkMozEmbed *

b

)

Method used to select the ALT link of the currently loaded XHTML page

Parameters:

embed

reference to the MozEmbed widget

Returns:

TRUE on succes

Definition at line 337 of file mozilla_api.cpp.

{
    return mozilla_link_module_goto_rel(b, "ALT");
}

Here is the call graph for this function:

gboolean mozilla_back

(

GtkMozEmbed *

b

)

Method used to go one step back in the browser history

Parameters:

embed

reference to the MozEmbed widget

Returns:

TRUE on succes

Definition at line 472 of file mozilla_api.cpp.

{
    g_return_val_if_fail(b != NULL, FALSE);

    if (gtk_moz_embed_can_go_back(GTK_MOZ_EMBED(b)))
    {
        gtk_moz_embed_go_back(GTK_MOZ_EMBED(b));
        return TRUE;
    }
    else
    {
        return FALSE;
    }
}

gint mozilla_determine_page_offset

(

GtkMozEmbed *

b

)

Method used to retrieve the scrolled offset of the currently loaded "one page" XHTML page

Parameters:

embed

reference to the MozEmbed widget

Returns:

offset (DEFAULT_PAGE_OFFSET when errors occured, or non-scrollable page)

Definition at line 650 of file mozilla_api.cpp.

{
    nsCOMPtr < nsIWebBrowser > wb;
    nsCOMPtr < nsIScrollable > scrollable;
    gint    offset = DEFAULT_PAGE_OFFSET;

    BR_PAGEBARPRINTF("mozilla_determine_page_offset -- entry\n");

    g_return_val_if_fail(b != NULL, DEFAULT_PAGE_OFFSET);

    BR_PAGEBARPRINTF("mozilla_determine_page_offset -- b != NULL\n");

    gtk_moz_embed_get_nsIWebBrowser(b, getter_AddRefs(wb));
    if (!wb)
    {
        BR_WARNPRINTF("mozilla_determine_page_offset -- wb == null\n");
        return (DEFAULT_PAGE_OFFSET);
    }

    // determine web page size
    scrollable = do_QueryInterface(wb);

    if (scrollable)
    {
        gint    minPos;
        gint    maxPos;
        gint    curPos;
        int     pixelscale, htmlSize, htmlPos;
        gulong  theWindowSize;

        scrollable->GetScrollRange(scrollable->ScrollOrientation_Y, &minPos, &maxPos);
        BR_PAGEBARPRINTF("scrollable->getScrollRange returned [%d,%d]\n", minPos, maxPos);
        scrollable->GetCurScrollPos(scrollable->ScrollOrientation_Y, &curPos);
        BR_PAGEBARPRINTF("scrollable->getCurScrollPos returned %d\n", curPos);

        // determine window size (in pixels) 
        theWindowSize = GetWebPageWindowSize(wb);
        BR_PAGEBARPRINTF("theWindowSize=%d\n", theWindowSize);

        // determine pixel scale to convert from twips to pixels
        // scaled to avoid using floats
        pixelscale = (int) (100 / GetWebPagePixelScale(wb));
        BR_PAGEBARPRINTF("100/pixelscale=%d\n", pixelscale);

        // Sizes in pixels, already scaled for percentage to avoid
        // using floats
        htmlSize = (maxPos - minPos);
        htmlPos = curPos * 100 + theWindowSize * pixelscale;

        // Calculate offset in percentage -- rounded to integer value
        offset = (gint) (htmlPos / htmlSize) + 1;
        if (offset > 100)
        {
            offset = 100;
        }
        BR_PAGEBARPRINTF("CALCULATED OFFSET = %d\n", offset);

    }

    return offset;
}

Here is the call graph for this function:

gboolean mozilla_get_page_type	(	GtkMozEmbed *	b,
		char **	type
	)

Method used to retrieve the type of a page (attribute of meta TAG)

Parameters:

	embed	reference to the MozEmbed widget
	type	return the type information (allocated memory should be cleared by the calling routine

Returns:

TRUE on succes

gboolean mozilla_handle_link

(

GtkMozEmbed *

b

)

Method used to select the previous link of the currently loaded XHTML page when no "previous" link is available the last link on the page will be selected

Parameters:

embed

reference to the MozEmbed widget

Returns:

TRUE on succes

Definition at line 425 of file mozilla_api.cpp.

{
    nsCOMPtr < nsIWebBrowser > wb;
    char   *urlValue;
    nsAutoString aHref;

    g_return_val_if_fail(b != NULL, FALSE);
    gtk_moz_embed_get_nsIWebBrowser(b, getter_AddRefs(wb));
    if (!wb)
        return (FALSE);

    // see if there is a focused element
    nsCOMPtr < nsIWebBrowserFocus > focus = do_QueryInterface(wb);
    nsCOMPtr < nsIDOMElement > focusElement;
    focus->GetFocusedElement(getter_AddRefs(focusElement));

    if (focusElement)
    {
        BR_MOZILLA_DOCPRINTF("There is a focused element");

        nsCOMPtr < nsIDOMHTMLAnchorElement > anchor = do_QueryInterface(focusElement);
        if (anchor)
        {
            anchor->GetHref(aHref);

            // return a new |char| buffer you must free with |nsMemory::Free|
            urlValue = ToNewCString(aHref);

            BR_MOZILLA_DOCPRINTF("node is anchor with url %s", urlValue);
            gtk_moz_embed_load_url(GTK_MOZ_EMBED(b), urlValue);

            nsMemory::Free(urlValue);
            return TRUE;
        }
        else
        {
            BR_MOZILLA_DOCPRINTF("node is NO anchor !!!!!");
        }                       // (anchor)
    }
    else
    {
        BR_MOZILLA_DOCPRINTF("page does not contain a focussed element");
    }
    return FALSE;
}

gboolean mozilla_next_link

(

GtkMozEmbed *

b

)

Method used to select the next link of the currently loaded XHTML page when no "next" link is available the first link on th epage will be selected

Parameters:

embed

reference to the MozEmbed widget

Returns:

TRUE on succes

Definition at line 223 of file mozilla_api.cpp.

{
    return mozilla_link_update(embed, NEXT_LINK);
}

Here is the call graph for this function:

gboolean mozilla_next_page

(

GtkMozEmbed *

b

)

Method used to go to the next page

Parameters:

embed

reference to the MozEmbed widget

Returns:

TRUE on succes

Definition at line 322 of file mozilla_api.cpp.

{
    return mozilla_link_module_goto_rel(b, "NEXT");
}

Here is the call graph for this function:

gboolean mozilla_overview_page

(

GtkMozEmbed *

b

)

Method used to select the INDEX link of the currently loaded XHTML page

Parameters:

embed

reference to the MozEmbed widget

Returns:

TRUE on succes

Definition at line 332 of file mozilla_api.cpp.

{
    return mozilla_link_module_goto_rel(b, "INDEX");
}

Here is the call graph for this function:

gboolean mozilla_previous_link

(

GtkMozEmbed *

b

)

Method used to select the currently focussed link

Parameters:

embed

reference to the MozEmbed widget

Returns:

TRUE on succes

Definition at line 228 of file mozilla_api.cpp.

{
    return mozilla_link_update(embed, PREVIOUS_LINK);
}

Here is the call graph for this function:

gboolean mozilla_previous_page

(

GtkMozEmbed *

b

)

Method used to go to the previous page

Parameters:

embed

reference to the MozEmbed widget

Returns:

TRUE on succes

Definition at line 327 of file mozilla_api.cpp.

{
    return mozilla_link_module_goto_rel(b, "PREV");
}

Here is the call graph for this function:

gboolean mozilla_save	(	GtkMozEmbed *	b,
		gchar *	file_name,
		gint	all
	)

Method used to save a webpage -- only used for debug reasons

Parameters:

	embed	reference to the MozEmbed widget
	filename	where to save
	all

Returns:

TRUE on succes

Definition at line 156 of file mozilla_api.cpp.

{
#ifdef SELECTION_ENABLED
    nsCOMPtr < nsIWebBrowser > wb;
    gint    i = 0;
    gchar  *relative_path = NULL;

    g_return_val_if_fail(b != NULL, FALSE);


    gtk_moz_embed_get_nsIWebBrowser(b, getter_AddRefs(wb));
    if (!wb)
        return (FALSE);

    nsCOMPtr < nsIWebNavigation > nav(do_QueryInterface(wb));

    nsCOMPtr < nsIDOMDocument > domDoc;
    nav->GetDocument(getter_AddRefs(domDoc));

    if (!domDoc)
        return (FALSE);
    nsCOMPtr < nsIWebBrowserPersist > persist(do_QueryInterface(wb));

    if (persist)
    {
        nsCOMPtr < nsILocalFile > file;
        nsCOMPtr < nsILocalFile > relative = nsnull;
        if (all)
        {

            relative_path = g_strdup(file_name);
            relative_path = g_strconcat(relative_path, "_files/", NULL);

            for (i = strlen(relative_path) - 1; i >= 0; --i)
                if (relative_path[i] == '/')
                {
                    relative_path[i] = '\0';
                    break;
                }

            mkdir(relative_path, 0755);

            nsAutoString s;

            s.AssignWithConversion(relative_path);
            NS_NewLocalFile(s, PR_TRUE, getter_AddRefs(relative));
        }

        nsAutoString s;

        s.AssignWithConversion(file_name);
        NS_NewLocalFile(s, PR_TRUE, getter_AddRefs(file));

        if (file)
            persist->SaveDocument(domDoc, file, relative, nsnull, 0, 0);

        if (all)
            g_free(relative_path);

        return (TRUE);
    }
#endif //SELECTION_ENABLED
    return (FALSE);
}

gboolean mozilla_scroll	(	int	count,
		GtkMozEmbed *	b
	)

Method to scroll on page up or down in the currently displayed XHTML page

Parameters:

	embed	reference to the MozEmbed widget
	count	number of pages to scroll (positive values move down in the view)

Returns:

TRUE when possible

Definition at line 624 of file mozilla_api.cpp.

{
    gboolean returnValue = FALSE;

    nsCOMPtr < nsIWebBrowser > wb;
    nsCOMPtr < nsITextScroll > textscrollInterface;

    g_return_val_if_fail(b != NULL, FALSE);

    BR_PAGEBARPRINTF("count %d", count);

    gtk_moz_embed_get_nsIWebBrowser(b, getter_AddRefs(wb));
    if (wb)
    {
        textscrollInterface = do_QueryInterface(wb);

        if (textscrollInterface)
        {
            // prevents scrolling off the end of the view
            textscrollInterface->ScrollByPages(count);
            returnValue = TRUE;
        }
    }
    return returnValue;
}

gboolean mozilla_scrollable	(	direction_t	direction,
		GtkMozEmbed *	b
	)

Method used to check if it possible to scroll on page down or up in the currently displayed XHTML page

Parameters:

	embed	reference to the MozEmbed widget
	direction

Returns:

TRUE when possible

Definition at line 570 of file mozilla_api.cpp.

{
    PRBool  scrollable = PR_FALSE;

    nsCOMPtr < nsIWebBrowser > wb;
    nsCOMPtr < nsIDocShell > doc_shell;
    nsCOMPtr < nsIPresShell > presShell;
    //nsCOMPtr < nsIViewManager > vm;
    //nsCOMPtr < nsIScrollableView > scrollview;

    gtk_moz_embed_get_nsIWebBrowser(b, getter_AddRefs(wb));

    if (wb)
    {
        doc_shell = do_GetInterface(wb);

        if (doc_shell)
        {
            doc_shell->GetPresShell(getter_AddRefs(presShell));

            if (presShell)
            {
                nsIViewManager *vm = presShell->GetViewManager();

                if (vm)
                {
                    nsIScrollableView *scrollableView = nsnull;

                    vm->GetRootScrollableView(&scrollableView);

                    if (scrollableView)
                    {
                        switch (direction)
                        {
                        case pageDown_t:
                            scrollableView->CanScroll(PR_FALSE, PR_TRUE, scrollable);
                            break;
                        case pageUp_t:
                            scrollableView->CanScroll(PR_FALSE, PR_FALSE, scrollable);
                            break;
                        }

                    }
                }

            }
        }
    }

    BR_PAGEBARPRINTF("return %s", (scrollable == PR_TRUE) ? "TRUE" : "FALSE");

    return scrollable;
}

char* mozilla_uri_to_path

(

const char *

uri

)

Method used to convert from uri to file system path.

Parameters:

uri

reference to the input uri

Returns:

the path in file system, NULL if fail

Definition at line 943 of file mozilla_api.cpp.

{
    // in fact, we should use nsIURI to get path from uri
    // just remove file:// prefix if there is any
    char * protocol = "file://";
    if (NULL == aUri)  return NULL;
    unsigned int min = strlen(protocol);

    if (strlen(aUri) <= min) return NULL;
    if (aUri != strstr(aUri, protocol))
    {
        return NULL;
    }
    
    char * path = strdup((char *) &aUri[min]);
    
    // we should handle the %20 %2f...
    raw_url_decode(path, strlen(path));
    return path;
    
    // the following code does not work, I don't know the reason, it once works
    /*
    nsresult rv;
    nsCOMPtr<nsIURI> theURI;
    rv = NS_NewURI(getter_AddRefs(theURI), aUri);
    if (NS_FAILED(rv)) return NULL;
    nsCAutoString  path;
    theURI->GetPath(path);
    return ToNewCString(path);
    */    
}       

Here is the call graph for this function:

gboolean mozilla_zoom	(	GtkMozEmbed *	b,
		float	size
	)

Method used to zoom the currently loaded page

Parameters:

	embed	reference to the MozEmbed widget
	size	zoom factor

Returns:

TRUE on succes

Definition at line 487 of file mozilla_api.cpp.

{
    nsCOMPtr < nsIWebBrowser > wb;
    nsCOMPtr < nsIDOMWindow > activeWindow;

    g_return_val_if_fail(b != NULL, FALSE);
    gtk_moz_embed_get_nsIWebBrowser(b, getter_AddRefs(wb));
    if (!wb)
        return (FALSE);

    BR_LOGPRINTF("mozilla_zoom -- GetDOMOWindowObject");

    activeWindow = GetDOMOWindowObject(wb);

    if ((activeWindow) && (size > 0))
    {
        activeWindow->SetTextZoom(size);
        return TRUE;
    }
    return FALSE;
}

Here is the call graph for this function:

int raw_url_decode	(	char *	str,
		int	len
	)

Definition at line 920 of file mozilla_api.cpp.

{
        char *dest = str;
        char *data = str;

        while (len--) {
                if (*data == '%' && len >= 2 && isxdigit((int) *(data + 1)) 
                        && isxdigit((int) *(data + 2))) {
                        *dest = (char) htoi(data + 1);
                        data += 2;
                        len -= 2;
                } else {
                        *dest = *data;
                }
                data++;
                dest++;
        }
        *dest = '\0';
        return dest - str;
}

Here is the call graph for this function: