Inheritance diagram

Collaboration diagram

Description

The following functions are available in the SFRBrowserControl class:

A simple Web Browser can be created easily by only pasting a SFRBrowserControl object.

The SFRBrowserControl class is implemented base on the IHtmlViewer of BREW API. The limitations of SFRBrowserControl class on rendering the HTML data are almost the same as that of IHtmlViewer.

Reference

SFRResponder | SFRApplication | SFRWindow | SFRDialog | SFRControl | SFBHTMLViewer | SFBWeb | Simple Web Browser

Member

Return value

Description

Initialize member variables, and create the IHtmlViewer interface for rendering the web pages.(*)

* The IWeb interface is not created here.

Description

The SFRBrowserControl::~SFRBrowserControl function terminates communication and rendering of HTML data and releases all the resources internally.

Return value

Description

Return the current history number as 0.

Reference

SFRBrowserControl::GetCurrentHistoryIndex

Argument

Instruction

By default nothing happens when the SFRBrowserControl::DoneNotifyHandler function is called.

To do something through this function, it is necessary to override the the SFRBrowserControl::DoneNotifyHandler function.

The timing when the SFRBrowserControl::DoneNotifyHandler function is called is different from that of the SFRBrowserControl::ResponseNotifyHandler function.

Example

Example of overriding.

#include <SFRResponder/SFRControl/SFRBrowserControl.hpp>

class MyBrowserControl : public SFRBrowserControl {
public:
    MyBrowserControl(SFRResponderPtr director, SFXRectangleConstRef rect)
        : SFRBrowserControl(director, rect) {
    }

protected:
    virtual Void DoneNotifyHandler(DoneNotifyConstRef notify) {
        if (notify.GetErrorCode() != SFERR_NO_ERROR) {
            // if communication error occored, show the error dialog
            ErrorDialog(notify.GetErrorCode());
        }
        else if (WEB_SUCCEEDED(notify.GetDoneCode())) {
            // if HTTP error occored, show the warning dialog
            WarningDialog(notify.GetResposenCode());
        }
    }
};

Reference

SFRBrowserControl::DoneNotify | SFRBrowserControl::FocusNotifyHandler | SFRBrowserControl::JumpNotifyHandler | SFRBrowserControl::ResponseNotifyHandler

Argument

Return value

Return the index of specified element when found. Return a minus value when not found.

Description

The SFRBrowserControl::FindElement function is used to search the specified element in the current page. The index of specified element that is found can be used in the SFRBrowserControl::GetElementText or SFRBrowserControl::GetElementAttribute function.

Reference

SFRBrowserControl::GetElementText | SFRBrowserControl::GetElementAttribute

Argument

Description

It do nothing in a standard implement.

If do something outside the standard, users need to override the FocusNotifyHandler() function.

Reference

SFRBrowserControl::FocusNotify | SFRBrowserControl::DoneNotifyHandler | SFRBrowserControl::JumpNotifyHandler | SFRBrowserControl::ResponseNotifyHandler

Return value

It returns the history of the current page.

Reference

SFRBrowserControl::GetCurrentHistoryIndex | SFRBrowserControl::GetHistory

Return value

It returns the current history index of the current page.

Description

It can be modified by Move function, Previous function, and Next function. And can be initialized to 0 by ClearHistory function.

Reference

SFRBrowserControl::Move | SFRBrowserControl::Previous | SFRBrowserControl::Next | SFRBrowserControl::ClearHistory

Argument

Return value

Return the content of attribute. If the specified attribute is not found, an empty string is returned.

Description

Get the attribute of specified element in the current page. if the specified element is not found, an empty string is returned.

	About the attribute without value.
	As for an element such as <HR NOSHADE> which has an attribute without value, when trying to get its attribute, "NOSHADE" which is the same as the name of attribute is returned.

Reference

SFRBrowserControl::FindElement | SFRBrowserControl::GetElementText

Argument

Return values

Return the content of element. If the specified element is empty, an empty string is returned.

Description

Get the text of specified element in the current page.

Reference

SFRBrowserControl::FindElement | SFRBrowserControl::GetElementAttribute

Argument

Return value

Return the history content. If there is no history content, or the historyIndex argument is invalid, an empty string is set to the "url" member of SFRBrowserControl::HistoryEntry structure.

Reference

SFRBrowserControl::HistoryEntry | SFRBrowserControl::GetHistoryList | SFRBrowserControl::GetCurrentHistory

Return value

Return a pointer to the history list: an array of SFRBrowserControl::HistoryEntry structure, which size is the return value by the SFRBrowserControl::GetHistorySize function.

Description

The top entry of history list is the latest history, and the history number matches with the index of entry of history list.

If no information is set to a history entry, its "url" member of SFRBrowserControl::HistoryEntry structure is set to an empty string.

	Warning
	The history list returned by the SFRBrowserControl::GetHistoryList function must not be modified.

Example

Display all the titles and URLs in the history list for debugging.

void PrintHistoryList(SFBrowserControlConstRef browser)
{
    int i;
    SFBrowserControl::HistoryEntryConstPtr historyList = browser.GetHistoryList();
    for (i=0; i < browser.GetHistorySize(); i++) {
        DBGPRINTF("title '%s' url %s",
                  (ACharConstPtr)historyList[i].title, (ConstACharPtr)historyList[i].url); 
    }
}

Reference

SFRBrowserControl::HistoryEntry | SFRBrowserControl::GetHistorySize

Return value

Return the number of entries in the current history list.

Description

The history number used by the SFRBrowserControl::Move or SFRBrowserControl::GetHistory function must be less than the number of entries in history list returned by the SFRBrowserControl::GetHistorySize function.

* The size of history list returned by the SFRBrowserControl::GetHistoryList function equals the return value of SFRBrowserControl::GetHistorySize function.

Reference

SFRBrowserControl::GetHistory | SFRBrowserControl::GetHistoryList | SFRBrowserControl::Move | SFRBrowserControl::SetHistorySize

Return value

Return the width of specified indent in pixels.

Reference

SFRBrowserControl::SetIndent

Return value

Return the color of link text.

Reference

SFRBrowserControl::SetLinkColor | SFRBrowserControl::GetTextColor

Return value

Return the spacing between paragraphs in pixels.

Reference

SFRBrowserControl::SetParagraphSpacing

Return value

Return the width of scroll bar in pixels.

Reference

SFRBrowserControl::SetScrollbarWidth

Return value

Return the text color of HTML.

Reference

SFRBrowserControl::SetTextColor | SFRBrowserControl::GetLinkColor

Return value

If the IWeb instance is not set by the SFRBrowserControl::SetWeb function and the IWeb instance is not created internally, return null.

Description

	Caution when specifying the WebOpt.
	Though any WebOpt can be set to the IWeb instance, the user setting of WebOpt must be preserved until another IWeb instance is used. Please see the "Instructions about the life-time of WEBOPT" in the BREW API Reference.

	The behavior when suspended.
	When suspended, the IWeb instance is set to be created internally by default settings. At this time, the information on WebOpt settings is also reset. To continue to use your own IWeb instance, set it by the resume handler again.

Reference

SFBWeb | SFRBrowserControl::UnsetWeb | SFRBrowserControl::SetWeb

Return value

Return value

Reference

SFRBrowserControl::SetInlineEditEnable

Return value

Reference

SFRBrowserControl::SetScrollbarEnable

Argument

Description

Open the linked URL automatically.

The SFRBrowserControl::JumpNotifyHandler function do nothing except the http://, https://, file://, and res:// streams.

To do something other than default settings, it is necessary to override the SFRBrowserControl::JumpNotifyHandler function.

Example

Example of overriding.

#include <SFRResponder/SFRControl/SFRBrowserControl.hpp>

class MyBrowserControl : public SFRBrowserControl {
public:
    MyBrowserControl(SFRResponderPtr director, SFXRectangleConstRef rect)
        : SFRBrowserControl(director, rect) {
    }

protected:
    virtual Void JumpNotifyHandler(JumpNotifyConstRef notify) {
        if (notify.GetUrl().StartWith("mailto:")) {
            // if it's "mailto:", call the mailer
            Mailer(notify.GetUrl());
        }
        else {
            // or just call the standard handler
            SFRBrowserControl::JumpNotifyHandler(notify);
        }
    }
};

Reference

SFRBrowserControl::JumpNotify | SFRBrowserControl::Open | SFRBrowserControl::DoneNotifyHandler | SFRBrowserControl::FocusNotifyHandler | SFRBrowserControl::ResponseNotifyHandler