Inheritance diagram

Collaboration diagram

Description

The following functions are available in the SFZWebBrowserControl class:

A simple web browser can be created easily by only pasting a SFZWebBrowserControl object.

The SFZWebBrowserControl class holds an internal SFYWebBrowserWidget instance. The SFYWebBrowserWidget class is implemented base on the IHtmlViewer of BREW API. The limitations of SFZWebBrowserControl class on rendering the HTML data are almost the same as that of IHtmlViewer.

	Fatal Error
	The SFZWebBrowserControl::HandleError function is invoked when an fatal error occurs.

	Privilege setting of mif file
	To use the SFZWebBrowserControl class, "Web Access" privilege must be checked by mif editor. To load an own root certificate file for SSL connection, "File" privilege must be also checked.

Sample Code

The following code displays a HTML document in a window by using the simple browser (the SFYWebBrowserWidget class).

SFMTYPEDEFRESPONDER(MyWindow)
class MyWindow : public SFZWindow{
    SFMSEALRESPONDER(MyWindow)
    SFMRESPONDERINSTANTIATEFOUR(MyWindow, SFZWindow, SFYContainer, SFYWidget, SFYResponder)
public:
    // Type of MyWindow
    enum CodeEnum {
        CODE_TYPE = four_char_code('M', 'W', 'N', 'D')
    };
    SFMTYPEDEFTYPE(CodeEnum)
public:
    static MyWindowSmp NewInstance(SFCErrorPtr exception = null);
    // Create and initialize a simple browser
    SFCError Make(Void);

protected:
    explicit MyWindow(Void) static_throws;
    virtual ~MyWindow(Void);

    // Simple browser
    SFZWebBrowserControlSmp _browser;

};

// Constructor
MyWindow::MyWindow(Void) static_throws
{
    if (static_try()) {
        // Set the responder type
        SetType(CODE_TYPE);
   }
}

// Destructor
MyWindow::~MyWindow(Void)
{
}

// Create and initialize a simple browser
SFCError MyWindow::Make(Void)
{
    SFCError error;

    // A HTML document to display
    SFXAnsiString buffer(
         "BrowserControl<br /><br />"
         "<a href=\"/example/tabbrowser/\">Sophia Craedle</a><br /><br />"
    );

    // Create an instance of the simple browser
    if ((_browser = SFZWebBrowserControl::NewInstance(&error)) != null) {

        if ((error = _browser->SetParent(GetThis())) == SFERR_NO_ERROR) {

            _browser->SetRealBound(GetLocalBound());

            _browser->SetState(true, true, true, true);

            // Open browser
            _browser->Open();

            // Load a HTML document
            _browser->Load(buffer);

            _browser->ToFront();
        }
    }
    return error;
}

Figure 408. Execution result

Reference

SFYControl | SFBHTMLViewer | SFYWebBrowserWidget::SetRequestHeader | SFYWebBrowserWidget::SetTimeoutCallback | SFYWebBrowserWidget::SetTimeoutMillisecond | BREW API IHtmlViewer | BREW API IWeb

Member

Internal Implementation

Internal implementation of this constructor is as follows:

/*protected */SFZWebBrowserControl::SFZWebBrowserControl(Void) static_throws
{
    static SFXEventRange::AtomRecConst          range[] = {
        { SFEVT_RESPONDER_BROWSER_NOTIFY, SFEVT_RESPONDER_BROWSER_NOTIFY, SFP16_BEGIN, SFP16_END }
    };
    SFYHandler::RuleRec                         rule[lengthof(range)];
    SFCError                                    error;

    if (static_try()) {
        SetType(CODE_TYPE);
        if ((_widget = SFYWebBrowserWidget::NewInstance(&error)) != null) {
            static_throw(_widget->SetParent(GetThis()));
            if (static_try()) {
                rule[0].spp = XANDLER_FUNCTION(OnNotify);
                rule[0].reference = this;
                static_throw(_widget->RegisterHandler(atomic_cast(range), rule, lengthof(range)));
                if (static_try()) {
                    _widget->SetState(true, true, true, true);
                }
            }
        }
        else {
            static_throw(error);
        }
    }
}// SFZWebBrowserControl::SFZWebBrowserControl //

/*private */XANDLER_IMPLEMENT_VOIDBROWSERNOTIFY(SFZWebBrowserControl, OnNotify, invoker, reason, notify)
{
    switch (reason) {
        case SFYWebBrowserWidget::NOTIFY_RESPONSE:
            ResponseNotifyHandler(*notify);
            break;
        case SFYWebBrowserWidget::NOTIFY_DONE:
            DoneNotifyHandler(*notify);
            break;
        case SFYWebBrowserWidget::NOTIFY_JUMP_SUBMIT:
            JumpNotifyHandler(*notify);
            break;
        case SFYWebBrowserWidget::NOTIFY_FOCUS:
            FocusNotifyHandler(*notify);
            break;
        case SFYWebBrowserWidget::NOTIFY_PAGE_DONE:
            break;
        case SFYWebBrowserWidget::NOTIFY_CONTENT_DONE:
            break;
        case SFYWebBrowserWidget::NOTIFY_FATAL_ERROR:
            HandleError(notify->u.nDone);
            break;
    }
    return;
}// XANDLER_IMPLEMENT_VOIDBROWSERNOTIFY(OnNotify) //

Reference

SFYWebBrowserWidget | SFYWebBrowserWidget::NotifyEnum | SFZWebBrowserControl::ResponseNotifyHandler | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::HandleError

Description

Nothing is done.

Return value

Description

This function adjusts the region of the internal IHTMLViewer instance.

This function is automatically called when the real region or the virtual region of this responder is changed.

When the global region of this responder is changed by other factors, explicit calling is necessary.

Description

This function cancels to connect to the Web server.

The registered callback and the connection timeout timer will be canceled, and the state of the HTTP connection will be restored before connecting, if called.

In general, this function is effective in the SFXHTTPConnection::STATE_CONNECT state.

This function is called in the SFZWebBrowserControl::Close function.

Reference

SFZWebBrowserControl::Close | SFZWebBrowserControl::SetTimeoutMillisecond | SFZWebBrowserControl::SetTimeoutCallback

Description

This function clears the history list.

Description

This function closes the HTTP connection.

This HTTP connection transits into the SFXHTTPConnection::STATE_CLOSE state.

Concretely, the following processings will be performed.

	Note
	This function is called in the SFZWebBrowserControl::~SFZWebBrowserControl destructor. This function calls the SFZWebBrowserControl::Cancel function internally.

Reference

SFZWebBrowserControl::~SFZWebBrowserControl | SFZWebBrowserControl::Open | SFZWebBrowserControl::Cancel | SFZWebBrowserControl::GetSFBWeb | SFZWebBrowserControl::GetSFBWebResp

Argument

Description

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

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

Example

The code below is to override this function.

#include <SFZResponder/SFZControl/SFZBrowserControl/SFZWebBrowserControl.hpp>

SFMTYPEDEFRESPONDER(MyBrowserControl)
class MyBrowserControl : public SFZWebBrowserControl {
    SFBSEALRESPONDER(MyBrowserControl)
    SFMRESPONDERINSTANTIATEFOUR(MyBrowserControl, SFZWebBrowserControl, SFYControl, SFYWidget, SFYResponder)
public:
    static MyBrowserControlSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit MyBrowserControl(Void) static_throws;
    virtual ~MyBrowserControl(Void);
    virtual Void DoneNotifyHandler(NotifyRef notify) {
        if (notify.u.nDone != SFERR_NO_ERROR) {
            // handle error
        }
    }
};

Internal Implementation

Internal implementation of this function is as follows:

/*protected virtual */Void SFZWebBrowserControl::DoneNotifyHandler(NotifyRef notify)
{
    unused(notify);
    return;
}// SFZWebBrowserControl::DoneNotifyHandler //

Reference

SFZWebBrowserControl::Notify | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

Argument

Return value

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

Description

The SFZWebBrowserControl::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 SFZWebBrowserControl::GetElementText function.

Reference

SFZWebBrowserControl::GetElementText

Argument

Description

It does nothing in a standard implement.

If does something outside the standard, users need to override the SFZWebBrowserControl::FocusNotifyHandler function.

Internal Implementation

Internal implementation of this function is as follows:

/*protected virtual */Void SFZWebBrowserControl::FocusNotifyHandler(NotifyRef notify)
{
    unused(notify);
    return;
}// SFZWebBrowserControl::FocusNotifyHandler //

Reference

SFZWebBrowserControl::Notify | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

Return value

Base URL of HTTP basic authentication

Description

Get the base URL of HTTP basic authentication.

The value which is set by the SFZWebBrowserControl::SetAuthorizeData function is gotten.

Reference

SFZWebBrowserControl::SetAuthorizeData

Return value

Value of the Content-Encoding field of the HTTP response header

Description

This function gets the value of the Content-Encoding field of the HTTP response header.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, the empty string(SFXAnsiString::EmptyInstance()) will be returned.

Reference

SFXAnsiString

Return value

Value of the Content-Length field of the HTTP response header

Description

This function gets the value of the Content-Length field of the HTTP response header.

If the Content-Length field of the HTTP response header does not exist or the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, -1 will be returned.

Return value

Value of the Content-Type field of the HTTP response header

Description

This function gets the value of the Content-Type field of the HTTP response header of the HTTP connection.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, the empty string(SFXAnsiString::EmptyInstance()) will be returned.

Reference

SFXAnsiString

Return value

Tite of the current page

Description

This function gets the title of the current page.

Reference

SFZWebBrowserControl::GetCurrentURL

Return value

URL of the current page

Description

This function gets the URL of the current page.

Reference

SFZWebBrowserControl::GetCurrentTitle

Return value

Value of the Date field of the HTTP response header as the SFXDate) instance

Description

This function gets the value of the Date field of the HTTP response header as the SFXDate) instance.

If the Date field of the HTTP response header does not exist or the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, SFXDate(0) will be returned.

Reference

SFXDate

Argument

Return value

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

Description

Get the text of the specified element in the current page.

Reference

SFZWebBrowserControl::FindElement

Return value

Value of the Expires field of the HTTP response header as the SFXDate) instance

Description

This function gets the value of the Expires field of the HTTP response header as the SFXDate) instance.

If the Expires field of the HTTP response header does not exist or the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, SFXDate(0) will be returned.

Reference

SFXDate

Return value

Width of specified indent in pixels.

Reference

SFZWebBrowserControl::SetIndent

Return value

Value of the Last-Modified field of the HTTP response header as the SFXDate) instance

Description

This function gets the value of the Last-Modified field of the HTTP response header as the SFXDate) instance.

If the Last-Modified field of the HTTP response header does not exist or the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, SFXDate(0) will be returned.

Reference

SFXDate

Return value

Color of the link text.

Reference

SFZWebBrowserControl::SetLinkColor | SFZWebBrowserControl::GetTextColor

Return value

HTTP request method of this HTTP connection

Description

This function gets the HTTP request method of this HTTP connection set with the SFZWebBrowserControl::SetMethod function.

If this HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, the empty string(SFXAnsiString::EmptyInstance()) will be returned.

Reference

SFZWebBrowserControl::SetMethod | SFZWebBrowserControl::Open | SFXAnsiString

Return value

Space between paragraphs in pixels.

Reference

SFZWebBrowserControl::SetParagraphSpacing

Return value

Password of HTTP basic authentication

Description

Get the password of HTTP basic authentication.

The value which is set by the SFZWebBrowserControl::SetAuthorizeData function is gotten.

Reference

SFZWebBrowserControl::SetAuthorizeData

Return value

Proxy server of this HTTP connection

Description

This function gets the proxy server of this HTTP connection set with the SFZWebBrowserControl::SetProxyServer function.

If this HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, or the proxy server of the HTTP connection has not been set, SFXSocketAddress::EmptyInstance() will be returned.

Reference

SFZWebBrowserControl::SetProxyServer | SFXSocketAddress

Return value

SFBSource instance that manages the HTTP request body of the HTTP connection

Description

This function gets the SFBSource instance that manages the HTTP request body of the HTTP connection, which is set with the SFZWebBrowserControl::SetRequestContent function.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, or the SFBSource instance has not been set, &SFBSourceSmp::EmptyInstance() will be returned.

Reference

SFZWebBrowserControl::SetRequestContent | SFBSource

Return value

HTTP request flag of this HTTP connection

Description

This function gets the HTTP request flag set with the SFZWebBrowserControl::SetRequestFlag function.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, 0 will be returned.

Reference

SFZWebBrowserControl::SetRequestFlag | SFZWebBrowserControl::Open | BREW API IWEB_GetResponse

Return value

HTTP request header of this HTTP connection

Description

This function gets the HTTP request header of the HTTP connection set with the SFZWebBrowserControl::SetRequestHeader function. It is possible to get the value of the field specified in the argument. If nothing is specified, all of the HTTP request header will be obtained.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, or the specified field of the HTTP request header or itself has not been set, the empty string(SFXAnsiString::EmptyInstance()) or the empty property(SFXProperty::EmptyInstance()) will be returned.

Reference

SFZWebBrowserControl::SetRequestHeader | SFXProperty | SFXAnsiString

Return value

SFBSource instance that manages the HTTP response body

Description

This function gets the SFBSource instance that manages the HTTP response body of the HTTP connection.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, SFBSourceSmp::EmptyInstance() will be returned.

	Tip
	After the HTTP connection is established, the HTTP response body can be obtained using this function.

	Note
	The SFZWebBrowserControl::GetStreamReader function gets the stream from the SFBSource instance, return value of the SFZWebBrowserControl::GetResponseContent function.

	Reading the HTTP response body
	If the HTTP response body is read by using the SFZWebBrowserControl::GetResponseContent function, the SFZWebBrowserControl::GetStreamReader function cannot be used. On the contrary, if the HTTP response body is read by using the SFZWebBrowserControl::GetStreamReader function, the SFZWebBrowserControl::GetResponseContent function cannot be used.

Reference

SFZWebBrowserControl::GetStreamReader | SFBSource

Return value

HTTP response flag of this HTTP connection

Description

This function gets the HTTP response flag of the HTTP connection.

The HTTP response flag can be represented as logical sum of the following flags:

If this HTTP connection is not in the STATE_OPEN_ESTABLISHED state, 0 will be returned.

Reference

SFZWebBrowserControl::SetRequestFlag | SFBWebResp | BREW API IWEBRESP_GetOpt

Return value

HTTP response header of this HTTP connection

Description

This function gets the HTTP response header of the HTTP connection set with the SFZWebBrowserControl::SetRequestHeader function. It is possible to get the value of the field specified in the argument. If nothing is specified, all of the HTTP response header will be obtained.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, or the specified field of the HTTP response header or itself has not been set, the empty string(SFXAnsiString::EmptyInstance()) or the empty property(SFXProperty::EmptyInstance()) will be returned.

Reference

SFXProperty | SFXAnsiString

Return value

HTTP status code of this HTTP connection.

Description

This function gets the HTTP status code of the HTTP connection.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, -1 will be returned.

If the HTTP connection has been established, the return value of this function is same as the nCode field of BREW API's WebRespInfo.

nCode represents either a protocol error code or a *negative* WEB_ERROR (see AEEError.h for codes), use WEB_ERROR_MAP(nCode) to map to AEE error, and WEB_ERROR_SUCCEEDED(nCode) to test for success. A positive number is one that was returned by the server, negative error codes are system errors.

	Note
	For more details on WEB_ERROR, see AEEError.h.

Reference

BREW API WebRespInfo | BREW API WEB_ERROR_MAP | BREW API WEB_ERROR_SUCCEEDED

Return value

SFBWeb instance managed internally by the HTTP connection.

Description

This function gets the SFBWeb instance managed internally by the HTTP connection.

Reference

SFBWeb | BREW API IWeb

Return value

SFBWebResp instance managed internally by the HTTP connection.

Description

This function gets the SFBWebResp instance managed internally by the HTTP connection.

Reference

SFBWebResp | BREW API IWebResp

Return value

Width of scroll bar in pixels.

Reference

SFZWebBrowserControl::SetScrollbarWidth

Return value

Description

This function gets the input stream for reading data from the HTTP response body of this HTTP connection.

If the size argument is specified, the buffer size of the input stream will be fixed with the specified value. Otherwise, the buffer size will be variable and the SFXElasticStreamReader class will be used internally.

	Tip
	You have to use the SFXBinaryStreamReader, SFXAnsiStringStreamReader, or SFXWideStringStreamReader class for the input stream properly depending on the type of data to be read.

	Reading the HTTP response body
	If the HTTP response body is read by using the SFZWebBrowserControl::GetResponseContent function, the SFZWebBrowserControl::GetStreamReader function cannot be used. On the contrary, if the HTTP response body is read by using the SFZWebBrowserControl::GetStreamReader function, the SFZWebBrowserControl::GetResponseContent function cannot be used.

	Note
	This function is valid if and only if the HTTP connection is in the SFXHTTPConnection::STATE_OPEN state.

Reference

SFZWebBrowserControl::GetResponseContent | SFXBinaryStreamReader | SFXAnsiStringStreamReader | SFXWideStringStreamReader | Stream Buffer

Return value

Description

This function gets the output stream for writing data onto the HTTP request body of the HTTP connection.

If the size argument is specified, the buffer size of the output stream will be fixed with the specified value. Otherwise, the buffer size will be variable and the SFXElasticStreamWriter class will be used internally.

	Tip
	You have to use the SFXBinaryStreamWriter, SFXAnsiStringStreamWriter, or SFXWideStringStreamWriter class for the output stream properly depending on the type of data to write.

	Writing the HTTP response body
	If the HTTP response body is set with the SFZWebBrowserControl::SetRequestContent function, the SFZWebBrowserControl::GetStreamWriter function cannot be used. On the contrary, if the HTTP response body is written by using the SFZWebBrowserControl::GetStreamWriter function, the SFZWebBrowserControl::SetRequestContent function cannot be used.

	Note
	This function is valid if and only if the HTTP connection is in the SFXHTTPConnection::STATE_OPEN state.

Reference

SFZWebBrowserControl::GetStreamReader | SFZWebBrowserControl::SetRequestContent | SFZWebBrowserControl::Open | SFXBinaryStreamWriter | SFXAnsiStringStreamWriter | SFXWideStringStreamWriter | Stream Buffer

Return value

Text color of HTML.

Reference

SFZWebBrowserControl::SetTextColor | SFZWebBrowserControl::GetLinkColor

Return value

Connection timeout period [in milliseconds]

Description

This function gets the connection timeout period. [in milliseconds]

Reference

SFZWebBrowserControl::SetTimeoutMillisecond | SFZWebBrowserControl::SetTimeoutCallback

Return value

SSL trust mode

Description

This function gets the SSL trust mode of this HTTP connection set with the SFZWebBrowserControl::SetTrustMode function.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, 0 will be returned.

Reference

SFZWebBrowserControl::SetTrustMode | SFZWebBrowserControl::Open | BREW API ISSL_NegotiateV

Return value

User name of HTTP basic authentication

Description

Get the user name of HTTP basic authentication.

The value which is set by the SFZWebBrowserControl::SetAuthorizeData function is gotten.

Reference

SFZWebBrowserControl::SetAuthorizeData

Return value

User agent of this HTTP connection

Description

This function gets the user agent of the HTTP request header of this HTTP connection set with the SFZWebBrowserControl::SetUserAgent function.

If the HTTP connection is not in the SFXHTTPConnection::STATE_OPEN state, the empty string(SFXAnsiString::EmptyInstance()) will be returned.

Reference

SFZWebBrowserControl::SetUserAgent | SFZWebBrowserControl::Open | SFXAnsiString

Return value

Web class ID

Description

This function gets the web class ID to open the HTTP/HTTPS connection.

Default value is AEECLSID_WEB.

Reference

SFZWebBrowserControl::SetWebClassId

Description

This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received.

In case you want to perform your own processing when the virtual region is changed, override this virtual function.

The default implementation sets real region of the internal SFYWebBrowserWidget instance to the region which is deflated about SFXMargin(2, 2) size from the local region.

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event will occur when the virtual region is changed by calling the SFYResponder::SetRealBound or SFYResponder::SetVirtualBound function.

Another method when the virtual region is changed

Other than overriding this virtual function, it is possible to define and implement the handler for region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the virtual region is updated, this virtual function is executed first, and next the handlers for region event are executed in the registered order. In almost all cases, the method to override this virtual function is adopted since defining, implementing and registering the handler for region event can be omitted.

Internal Implementation

Internal implementation of the SFZWebBrowserControl::HandleBoundVirtual function is as follows:

/*protected virtual */Void SFZWebBrowserControl::HandleBoundVirtual(Void)
{
    SFXRectangle                                rx;

    rx.Set(GetLocalBound());
    rx.Deflate(2, 2);
    _widget->SetRealBound(rx);
    return;
}// SFZWebBrowserControl::HandleBoundVirtual //

Reference

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | Real Region | Virtual Region | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function is called when a fatal error occurs in the SFZWebBrowserControl class.

Default does nothing.

Description

This function will be called when the (SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) event is received.

In case you want to perform your own drawing of this responder, override this function.

The default implementation is to draw this responder.

The method to darw a responder

In addition to overriding this virtual function, it is possible to define and implement the handler for drawing event(drawing handler)[XANDLER_DECLARE_VOIDRENDER], and register it into the responder. Then, the overridden virtual function will be called first, and next the drawing handlers registered into the responder will be booted up in the registered order. In almost all cases, the method to override this function is used to draw the responder since there is no need to declare and register the drawing handler.

Procedure of drawing a responder

The drawing handler will be booted up when the drawing event(SFEVT_RESPONDER_RENDER) occurs. And then the drawing handler draw the responder actually. The drawing event will be sent to only the responders including the region to be redrawn out of the redraw regions registered into the renderer using the SFYResponder::InvokeBackward function after the SFYResponder::Render function boots up the renderer. Here, the SFYResponder::Render function will be called at the following situations: At the end of the event loop At the applet start / resume or the end of a highest priority event handler In the callback, which is outside the event loop. If calling the SFYResponder::Render function with specifying "true" as an argument, the drawing event will be sent to all the responders to be actually displayed on the screen which are located below the responder in the responder tree, regardless of the registration of redraw region.

Internal Implementation

Internal implementation of the SFZWebBrowserControl::HandleRenderRequest function is as follows:

/*protected virtual */Void SFZWebBrowserControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    static SFXBevelColor::AtomRecConst          frameRgb = {
        {{{0x00, 0xAA, 0xAA, 0xAA}}}, {{{0x00, 0xFF, 0xFF, 0xFF}}}, {{{0x00, 0xFF, 0xFF, 0xFF}}}
    };
    static SFXRGBColor::AtomRecConst            theme[] = {
        {{{0x00, 0x00, 0x00, 0x00}}},
        {{{0x00, 0xDD, 0x99, 0x99}}},
        {{{0x00, 0xFF, 0xFF, 0xFF}}}
    };
    SFBDisplaySmp                               display;
    SFXRectangle                                rx;

    rx.Set(GetLocalBound());
    graphics->DrawBevelRectangle(rx, frameRgb);
    rx.Deflate(1, 1);
    graphics->DrawRectangle(rx, theme[0]);
    rx.Deflate(1, 1);
    if (GetStateFocus(true)) {
        graphics->DrawRectangle(rx, theme[1]);
    }
    else {
        graphics->DrawRectangle(rx, theme[2]);
    }
    return;
}// SFZWebBrowserControl::HandleRenderRequest //

Reference

SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | Event Loop | Responder Tree

Return value

Return value

Reference

SFZWebBrowserControl::SetInlineEditEnable

Return value

Reference

SFZWebBrowserControl::SetScrollbarEnable

Argument

Description

Open the linked URL automatically.

The SFZWebBrowserControl::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 SFZWebBrowserControl::JumpNotifyHandler function.

Example

The code below is to override the SFZWebBrowserControl::JumpNotifyHandler function.

#include <SFZResponder/SFZControl/SFZBrowserControl/SFZWebBrowserControl.hpp>

SFMTYPEDEFRESPONDER(MyBrowserControl)
class MyBrowserControl : public SFZWebBrowserControl {
    SFBSEALRESPONDER(MyBrowserControl)
    SFMRESPONDERINSTANTIATEFOUR(MyBrowserControl, SFZWebBrowserControl, SFYControl, SFYWidget, SFYResponder)
public:
    static MyBrowserControlSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit MyBrowserControl(Void) static_throws;
    virtual ~MyBrowserControl(Void);
    virtual Void JumpNotifyHandler(NotifyRef notify) {
        if (notify.GetUrl().StartWith("mailto:")) {
            // if it's "mailto:", call the mailer
            Mailer(notify.GetUrl());
        }
        else {
            // or just call the standard handler
     SFZWebBrowserControl::JumpNotifyHandler(notify);
        }

        if (notify.ex.absoluteURL.StartWith("mailto:")) {
            // if it's "mailto:", call the mailer
            Mailer(notify.ex.absoluteURL);
        }
        else {
            // or just call the standard handler
            SFZWebBrowserControl::JumpNotifyHandler(notify);
        }

    }
};

Internal Implementation

Internal implementation of this function is as follows:

/*protected virtual */Void SFZWebBrowserControl::JumpNotifyHandler(NotifyRef notify)
{
    Navigate(notify.ex.absoluteURL);
    return;
}// SFZWebBrowserControl::JumpNotifyHandler //

Reference

SFZWebBrowserControl::Notify | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

Argument

Return value

Description

Immediately after the inline image is received, it is displayed.

	About communication error:
	The communication errors cannot be gotten from the return value of SFZWebBrowserControl::Load function. To get the communication errors, it is necessary to handle the (SFEVT_RESPONDER_BROWSER_NOTIFY, NOTIFY_RESPONSE) event.

Reference

SFZWebBrowserControl::Navigate

Argument

Return value

Description

This function loads a file or buffer of ASN.1/DER form certificate.

This function is valid if and only if the HTTP connection is in the STATE_CLOSE.

Example

Load a root certificate file

SFZWebBrowserControl http;
SFCError error;

// Load a root certificate before open.
if ((error = http.LoadCertificate(WEBOPT_X509_ROOT_CERT, SFXPath("scradle.der"))) == SFERR_NO_ERROR) {
    if ((error = http.Open()) == SFERR_NO_ERROR) {
        error = http.Connect("https://www.s-cradle.com/example/tabbrowser/", XALLBACK_INTERNAL(OnConnect));
    }
}

Reference

SFBX509Chain::AddCert

Argument

Return value

Description

This function gets a page which is specified by the argument, and starts to render it.

Immediately after the inline image is received, it is displayed.

Before calling this function, the connection must be opened by the SFZWebBrowserControl::Open function, and the HTML method must be set by the SFZWebBrowserControl::SetMethod function.

	Abount communication error:
	The communication errors cannot be gotten from the return value of SFZWebBrowserControl::Navigate function. To get the communication errors, it is necessary to handle the (SFEVT_RESPONDER_BROWSER_NOTIFY, NOTIFY_RESPONSE) event.

Example

SFZWebBrowserControlSmp browser;
SFCError error;

if ((browser = SFZWebBrowserControl::NewInstance(&error)) != null) {
    if ((error = browser->Open()) == SFERR_NO_ERROR) {
        if ((error = browser->SetMethod("GET")) == SFERR_NO_ERRROR) {
            error = browser->Navigate("/example/tabbrowser/");
        }
    }
}

Reference

SFZWebBrowserControl::Load | SFZWebBrowserControl::Open | SFZWebBrowserControl::SetMethod

Argument

Return value

Description

If the specified index number is negative, the history entry go back by its absolute value is displayed. If it is out of the history list, SFERR_INVALID_PARAM is returned as an error.

	About communication error:
	The communication errors cannot be gotten from the return value of SFZWebBrowserControl::Next function. To get the communication errors, it is necessary to handle the (SFEVT_RESPONDER_BROWSER_NOTIFY, NOTIFY_RESPONSE) event.

Reference

SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Previous | SFZWebBrowserControl::Reload

Return value

Description

This function opens this HTTP connection.

This HTTP connection transits into the SFXHTTPConnection::STATE_OPEN state.

Concretely, the following processings will be performed.

Argument

Return value

Description

If the specified index number is negative, the history entry go back by its absolute value is displayed. If it is out of the history list, SFERR_INVALID_PARAM is returned as an error.

	About communication error:
	The communication errors cannot be gotten from the return value of SFZWebBrowserControl::Previous function. To get the communication errors, it is necessary to handle the (SFEVT_RESPONDER_BROWSER_NOTIFY, NOTIFY_RESPONSE) event.

Reference

SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Next | SFZWebBrowserControl::Reload

Description

When the current page is displayed by the SFZWebBrowserControl::Load function or by the SFZWebBrowserControl::Navigate function with the argument of IAStream or ISource, the redrawing fails.

Reference

SFZWebBrowserControl::Load | SFZWebBrowserControl::Navigate

Argument

Description

This function is called before rendering.

The standard implement is to do nothing.

Example

The code below is to override this function.

#include <SFZResponder/SFZControl/SFZBrowserControl/SFZWebBrowserControl.hpp>

SFMTYPEDEFRESPONDER(MyBrowserControl)
class MyBrowserControl : public SFZWebBrowserControl {
    SFBSEALRESPONDER(MyBrowserControl)
    SFMRESPONDERINSTANTIATEFOUR(MyBrowserControl, SFZWebBrowserControl, SFYControl, SFYWidget, SFYResponder)
public:
    static MyBrowserControlSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit MyBrowserControl(Void) static_throws;
    virtual ~MyBrowserControl(Void);
    virtual Void ResponseNotifyHandler(NotifyRef notify) {
        if (!WEB_ERROR_SUCCEEDED(notify.u.nDone)) {
            // if there is a HTTP error, show the warning dialog
            WarningDialog(notify.u.nDone);
        }
        return;
    }
};

Internal Implementation

Internal implementation of this function is as follows:

/*protected virtual */Void SFZWebBrowserControl::ResponseNotifyHandler(NotifyConstRef notify)
{
    unused(notify);
    return;
}// SFZWebBrowserControl::ResponseNotifyHandler //

Reference

SFZWebBrowserControl::Notify | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler

Argument

Return value

Description

This function sets the information of HTTP basic authentication.

After calling this fuction, pages whose URL starts with specified url argument will be accessed with basic authentication header.

This function is valid if and only if the HTTP connection is in the STATE_OPEN.

To unset the basic authentication information, call this function with specifying empty strings.

	Note
	If a return value is not SFERR_NO_ERROR, the basic authentication is not performed.

Reference

SFZWebBrowserControl::Open

Argument

Return value

Reference

SFZWebBrowserControl::GetIndent

Argument

Reference

SFZWebBrowserControl::IsInlineEditEnable

Argument

Return value

Reference

SFZWebBrowserControl::GetLinkColor | SFZWebBrowserControl::SetTextColor

Return value

Description

This function sets he HTTP request method of the HTTP connection.

As the method argument, the methods supported by the BREW IWeb interface such as "GET", "POST", "HEAD" can be specified.

Default: "GET"

The value set by the this function will be effective until the SFZWebBrowserControl::Close function is called.

	Note
	This function is valid if and only if this HTTP connection is in the STATE_OPEN state.

Reference

SFZWebBrowserControl::GetMethod | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | SFXAnsiString | BREW API IWeb

Argument

Return value

Reference

SFZWebBrowserControl::GetParagraphSpacing

Return value

Description

This function sets the proxy server (SFXSocketAddress) of the HTTP connection to the specified value.

The value set by the this function will be effective until the SFZWebBrowserControl::Close function is called.

	Note
	This function is valid if and only if the HTTP connection is in the SFXHTTPConnection::STATE_OPEN state.

Reference

SFZWebBrowserControl::GetProxyServer | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close SFXSocketAddress

Return value

Description

This function sets the HTTP request body of the HTTP connection to the specified storage or source.

If only the file or memory storage is specified in the argument, its total storage length will be automatically set.

When the length argument is specified, data of the specified length from the current read / write pointer of the storage or source will be set to the HTTP request body of the HTTP connection.

Tip

If a file storage(SFXFile) is set with the SFZWebBrowserControl::SetRequestContent function, data will be sent directly to the network from the file storage. As a result, big data can be sent. When data is sent with the SFZWebBrowserControl::GetStreamWriter function, the HTTP request body is made in the heap befre sent. As a result, the data size that can be sent will depends on the memory size equipped with the handset device.

	Writing the HTTP response body
	If the HTTP response body is set with the SFZWebBrowserControl::SetRequestContent function, the SFZWebBrowserControl::GetStreamWriter function cannot be used. On the contrary, if the HTTP response body is written by using the SFZWebBrowserControl::GetStreamWriter function, the SFZWebBrowserControl::SetRequestContent function cannot be used.

The value set by the this function will be effective until the SFZWebBrowserControl::Close function is called.

	Note
	This function is valid if and only if the HTTP connection is in the SFXHTTPConnection::STATE_OPEN state.

	Note
	The SFZWebBrowserControl::SetRequestContent function is effective in SophiaFramework UNIVERSE 5.1.11 or above.

Reference

SFZWebBrowserControl::GetRequestContent | SFZWebBrowserControl::GetStreamWriter | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | SFBSource | SFXStorage

Return value

Description

This function sets the HTTP request flag of the HTTP connection to the specified value.

	Note
	This HTTP request flag will be internally passed to the IWEB_GetResponse function.

Concretely, the logical sum of the following flags are set as the flag argument.

The value set by the this function will be effective until the SFZWebBrowserControl::Close function is called.

	Note
	This function is valid if and only if the HTTP connection is in the SFXHTTPConnection::STATE_OPEN state.

Reference

SFZWebBrowserControl::GetRequestFlag | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | BREW API IWEB_GetResponse

Return value

Description

This function sets the HTTP request header to the specified (key, value) pair.

If this function is called several times with the same key, all the requests are stored together and then will be sent at a time.

The values set by the SFZWebBrowserControl::SetRequestHeader function will be destroyed when the SFZWebBrowserControl::Close function is called or the connection to the Web server is established.

The value set by the this function will be effective until the SFZWebBrowserControl::Close function is called.

	Note
	This function is valid if and only if the HTTP connection is in the SFXHTTPConnection::STATE_OPEN state.

Reference

SFZWebBrowserControl::GetRequestHeader | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close

Argument

Description

The scroll bar here is not of SophiaFramework UNIVERSE, but of the standard BREW.

Reference

SFZWebBrowserControl::IsScrollbarEnable

Argument

Return value

Reference

SFZWebBrowserControl::GetScrollbarWidth

Argument

Return value

Reference

SFZWebBrowserControl::GetTextColor | SFZWebBrowserControl::SetLinkColor

Description

This function sets the connection timeout callback, which will be called in case there is no response from the server when the connection timeout period elapses from the communication startup.

If no callback is set, by default, the SFXHTTPConnection::OnTimeoutDefault function will be registered as a connection timeout callback.

The SFXHTTPConnection::OnTimeoutDefault function cancels the communication by calling the SFXHTTPConnection::Cancel function as in the internal implementation code below.

/*private */XALLBACK_IMPLEMENT_SFXTIMER(SFXHTTPConnection, OnTimeoutDefault)
{
    Cancel();
    return;
}// XALLBACK_IMPLEMENT_SFXTIMER(SFXHTTPConnection, OnTimeoutDefault)

	Note
	The connection timeout period is set by using the SFZWebBrowserControl::SetTimeoutMillisecond function.

Reference

SFZWebBrowserControl::SetTimeoutMillisecond | SFZWebBrowserControl::Cancel | SFXHTTPConnection::Cancel

Description

This function sets the connection timeout period to the specified value. [in milliseconds]

Defualt: 0 (Timeout processing will not be performed.)

In case there is no response from the server when the connection timeout period elapses from the communication startup, the connection timeout callback registered by calling the SFZWebBrowserControl::SetTimeoutCallback function will be called.

	Note
	If the connection timeout period is set to 0, timeout processing will not be performed.

Reference

SFZWebBrowserControl::GetTimeoutMillisecond | SFZWebBrowserControl::SetTimeoutCallback

Return value

Description

This function sets the SSL trust mode of the HTTP connection to the specified value (effective only if this HTTP connection is HTTPS).

The value set by this function is effective until the SFZWebBrowserControl::Close function is called.

The SSL_RESULT_SERV_VERS error might occur on the handset device when calling the connecting function immediately after this value is changed.

To avoid this error, call the SFZWebBrowserControl::Close function once, set the SSL trust mode, and then call the connecting function.

One of the following values are available for the SSL trust mode:

	Note
	For more details, see BREW API ISSL_NegotiateV in the BREW API Reference

	Note
	This function is valid if and only if the HTTP connection is in the SFXHTTPConnection::STATE_OPEN state.

Reference

SFZWebBrowserControl::GetTrustMode | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | BREW API ISSL_NegotiateV

Return value

Description

This function sets the user agent of the HTTP connection to the specified value.

The value set by the this function will be effective until the SFZWebBrowserControl::Close function is called.

	Note
	This function is valid if and only if the HTTP connection is in the SFXHTTPConnection::STATE_OPEN state.

Reference

SFZWebBrowserControl::GetUserAgent | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | SFXAnsiString

Description

This function sets the web class ID to open the HTTP/HTTPS connection.

Default value is AEECLSID_WEB.

Reference

SFZWebBrowserControl::GetWebClassId

Description

Nothing happens except under rendering. The content that has already been displayed takes no influence by calling the SFZWebBrowserControl::Stop function.

Reference

SFYResponder::GetType | SFYResponder::SetType

Description

Reference

SFYWebBrowserWidget::NotifyEnum | BREW API HViewNotify | BREW API WEB_ERROR_SUCCEEDED | BREW API WEB_ERROR_MAP