 |
Coherent UI
2.5.3
A modern user interface library for games
|
|
Coherent UI
2.5.3
A modern user interface library for games
|
Class that encapsulates a browser View Provides all manipulation and query functions for the view. More...
#include <Coherent/UI/BrowserView.h>
Inheritance diagram for Coherent::UI::BrowserView:Public Member Functions | |
| virtual ViewType | GetViewType ()=0 |
| Get The type of this view. More... | |
| virtual void | GoBack ()=0 |
| Navigates back to the previous URL, if any. | |
| virtual void | GoForward ()=0 |
| Navigates to the next URL, if any (i.e. available after navigating back) | |
| virtual void | GetHistory ()=0 |
| Issues a request for obtaining the navigation history for the view. More... | |
| Public Member Functions inherited from Coherent::UI::View | |
| virtual ViewContext * | GetContext () const =0 |
| Get the view context. More... | |
| virtual void | Destroy ()=0 |
| Destroys this view. More... | |
| virtual void | SetFocus ()=0 |
| Sets this view on focus. | |
| virtual void | KillFocus ()=0 |
| Removes the focus from this view. | |
| virtual void | MouseEvent (const MouseEventData &event)=0 |
| Sends a mouse event to the UI renderer. More... | |
| virtual void | KeyEvent (const KeyEventData &event)=0 |
| Sends a key event to the UI renderer. More... | |
| virtual void | TouchEvent (const TouchEventData *events, unsigned count)=0 |
| Sends a touch event to the UI renderer. More... | |
| virtual void | MouseActivate ()=0 |
| Sends a mouse event to the UI renderer. | |
| virtual int | GetWidth () const =0 |
| Gets the width of the View. More... | |
| virtual int | GetHeight () const =0 |
| Gets the height of the View. More... | |
| virtual void | Resize (unsigned width, unsigned height)=0 |
| Send a resize event to the UI renderer. More... | |
| virtual void | IssueMouseOnUIQuery (float normX, float normY)=0 |
| Issues a query on the View to check of the mouse is on the user interface or not. More... | |
| virtual ViewErrorType | HasMouseQueryFinished ()=0 |
| Returns the status of the mouse query. More... | |
| virtual void | FetchMouseOnUIQuery ()=0 |
| Ends a mouse-on-UI query. Waits for the result. More... | |
| virtual bool | IsMouseOnView ()=0 |
| Checks if the mouse is currently on the logical view (a part of the view that has elements on it) or not (click-through). Uses the coordinates last set in IssueMouseOnUIQuery. More... | |
| virtual void | SetClickThroughAlphaThreshold (float threshold)=0 |
| The alpha value of the pixels is used to determine if the mouse is on an element or on the background (click-through). All pixels below or equal to the alpha threshold (default = 0) are marked as not-belonging to the View and IsMouseOnView for them return false. More... | |
| virtual float | GetClickThroughAlphaThreshold () const =0 |
| Get the currently set alpha threshold for click-through queries. More... | |
| virtual void | SetTargetFramerate (int target)=0 |
| Sets the target frame-rate for the View. The View's rendering will never exceed the target frame-rate. It also will never exceed the frame-rate set when initializing the view. (available only in Full versions of Coherent UI) More... | |
| virtual int | GetTargetFramerate () const =0 |
| Get the currently set target frame-rate for the View. More... | |
| virtual bool | IsOnDemand () const =0 |
| Tells if this is an on-demand view. Frames must be explicitly requested for on-demand views (available only in Full versions of Coherent UI) More... | |
| virtual ViewErrorType | RequestFrame ()=0 |
| Requests a new frame for rendering. All triggered events before this call will be accounted for in the rendered view. Only one frame per-view could be requested simultaneously (available only in Full versions of Coherent UI) More... | |
| virtual ViewErrorType | RequestFrame (double timeSinceArbitraryMoment)=0 |
| Requests a new frame for rendering. All triggered events before this call will be accounted for in the rendered view. Only one frame per-view could be requested simultaneously (available only in Full versions of Coherent UI) This function can be called from a thread different than the main UI context thread in order to support client applications with multi-threaded rendering. More... | |
| virtual ViewErrorType | PeekFrameReady ()=0 |
| Tells if the last requested frame is ready or not. Does not block. This call must always be made between calls to RequestFrame and FetchSurface. (available only in Full versions of Coherent UI) This function can be called from a thread different than the main UI context thread in order to support client applications with multi-threaded rendering. More... | |
| virtual ViewErrorType | FetchSurface ()=0 |
| Returns the requested surface. Works only for on-demand views. All buffered view should use the context's FetchSurfaces method. This call will block until the surface is ready. (available only in Full versions of Coherent UI) This function can be called from a thread different than the main UI context thread in order to support client applications with multi-threaded rendering. More... | |
| virtual ViewErrorType | DrawSurface ()=0 |
| [EXPERIMENTAL - DO NOT USE] | |
| virtual bool | UsesSharedMemory () const =0 |
| Tells if this view uses shared memory for image transport. More... | |
| virtual bool | IsTransparent () const =0 |
| Tells if this view is transparent or not. More... | |
| virtual bool | SupportsClickThrough () const =0 |
| Tells if this view supports click-through queries or not. More... | |
| virtual void | Redraw () const =0 |
| Request a redraw of the current view. | |
| virtual void | DownloadUrl (const wchar_t *path)=0 |
| Initiates a download request on the specified path. | |
| virtual void | Load (const wchar_t *path)=0 |
| Loads a new path in the View. More... | |
| virtual void | Reload (bool ignoreCache)=0 |
| Reloads the last requested or navigated-to path. More... | |
| virtual const wchar_t * | GetCurentViewPath () const =0 |
| Get the last requested or navigated-to path. More... | |
| virtual const wchar_t * | GetLastRequestedPath () const =0 |
| Get the last requested path to load for the View. More... | |
| virtual const wchar_t * | GetLastLoadedPath () const =0 |
| Get the last successfully loaded path for the View. More... | |
| virtual const wchar_t * | GetLastFailedPath () const =0 |
| Get the last failed path for the View. More... | |
| virtual BoundEventHandle | RegisterForEvent (const char *name, IEventHandler *handler)=0 |
| Expose C++ handler to be called when a specific event occurs. More... | |
| virtual void | UnregisterFromEvent (BoundEventHandle handle)=0 |
| Remove a registered C++ handler. More... | |
| virtual BoundEventHandle | BindCall (const char *name, IEventHandler *handler)=0 |
| Expose C++ handler to be called from UI. More... | |
| virtual void | UnbindCall (BoundEventHandle handle)=0 |
| Remove a bound C++ handler. More... | |
| virtual void | UnbindObject (const void *object)=0 |
| Remove all handlers bound to a specific object. More... | |
| virtual void | ExecuteScript (const char *script)=0 |
| Execute arbitrary JavaScript code. More... | |
| virtual void | ReplyToJavaScriptMessage (bool success, const char *userInput) const =0 |
| Sends a reply to a javascript message triggered for the view. More... | |
| virtual void | AuthCredentialsResponse (const wchar_t *username, const wchar_t *password, bool success) const =0 |
| Sends credentials for a pending authentication request for the view. More... | |
| virtual void | SetScriptError (ScriptCallErrorType error, const char *message)=0 |
| Sets an error for the currently executing handler. More... | |
| virtual void | InterceptURLRequests (bool intercept)=0 |
Controls intercepting URL requests. For each request ViewListener::OnURLRequest will be called. More... | |
| virtual void | IMEActivate (bool active)=0 |
| Sets if the View should notify the client about IME-related events and if it will process IME messages. More... | |
| virtual bool | IMEIsActive () const =0 |
| Tells if IME events are currently active for this view. More... | |
| virtual bool | IMESetComposition (const wchar_t *composition, unsigned cursorPos, unsigned targetStart, unsigned targetEnd)=0 |
| Updates the internal state of the IME composition in the View. More... | |
| virtual bool | IMEConfirmComposition (const wchar_t *composition)=0 |
| Confirms the current IME composition. More... | |
| virtual bool | IMECancelComposition ()=0 |
| Cancels the current IME composition. More... | |
| virtual ImageData * | CreateImageData (const char *name, int width, int height, void *data, bool flipY)=0 |
| Create an ImageData object in the View that can be updated fast from the client application itself. More... | |
| virtual int | GetAudioData (int streamId, void *buffer, int bufferSize, int timeoutMs)=0 |
| Obtains audio data for the specified stream in the current view and copies it into the client-provided buffer. More... | |
| virtual void | SetZoomLevel (double zoomLevel)=0 |
| Sets the page zoom level. Specifying 0.0 will reset to the default zoom level. More... | |
| virtual void | SetMasterVolume (double volume)=0 |
| Sets the master volume for all audio and video streams. More... | |
| virtual void | TriggerEvent (const char *eventName)=0 |
| Triggers a UI event. | |
| template<typename T1 > | |
| void | TriggerEvent (const char *name, const T1 &argument1) |
| Triggers a UI event. | |
| template<typename T1 , typename T2 > | |
| void | TriggerEvent (const char *name, const T1 &argument1, const T2 &argument2) |
| Triggers a UI event. | |
| template<typename T1 , typename T2 , typename T3 > | |
| void | TriggerEvent (const char *name, const T1 &argument1, const T2 &argument2, const T3 &argument3) |
| Triggers a UI event. | |
| template<typename T1 , typename T2 , typename T3 , typename T4 > | |
| void | TriggerEvent (const char *name, const T1 &argument1, const T2 &argument2, const T3 &argument3, const T4 &argument4) |
| Triggers a UI event. | |
Class that encapsulates a browser View Provides all manipulation and query functions for the view.
|
pure virtual |
Issues a request for obtaining the navigation history for the view.
|
pure virtual |
