struct CCL::INavigator

Overview

Basic navigator interface. More…

#include <inavigator.h>

struct INavigator: public CCL::IUnknown
{
    // methods

    virtual tresult CCL_API navigate (UrlRef url) = 0;
    virtual tresult CCL_API navigateDeferred (UrlRef url) = 0;
    virtual tresult CCL_API refresh () = 0;
    virtual UrlRef CCL_API getCurrentUrl () const = 0;
    virtual StringRef CCL_API getCurrentTitle () const = 0;
    virtual tresult CCL_API goBack () = 0;
    virtual tresult CCL_API goForward () = 0;
    virtual tbool CCL_API canGoBack () const = 0;
    virtual tbool CCL_API canGoForward () const = 0;
    virtual tresult CCL_API goHome () = 0;
    virtual UrlRef CCL_API getHomeUrl () const = 0;
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Basic navigator interface.

Methods

virtual tresult CCL_API navigate (UrlRef url) = 0

Navigate to new location.

virtual tresult CCL_API navigateDeferred (UrlRef url) = 0

Navigate to new location deferred.

virtual tresult CCL_API refresh () = 0

Refresh current location.

virtual UrlRef CCL_API getCurrentUrl () const = 0

Get URL of current location.

virtual StringRef CCL_API getCurrentTitle () const = 0

Get title of current location.

virtual tresult CCL_API goBack () = 0

Navigate to previous location.

virtual tresult CCL_API goForward () = 0

Navigate to next location.

virtual tbool CCL_API canGoBack () const = 0

Check if backward navigation possible.

virtual tbool CCL_API canGoForward () const = 0

Check if forward navigation possible.

virtual tresult CCL_API goHome () = 0

Navigate to home location.

virtual UrlRef CCL_API getHomeUrl () const = 0

Get URL of home location.