FireBreath  1.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Pages
Public Member Functions | List of all members
FB::ActiveX::IDispatchAPI Class Reference

Provide a JSObject implementation to wrap a IDispatch ActiveX object. More...

#include "IDispatchAPI.h"

Inheritance diagram for FB::ActiveX::IDispatchAPI:
Inheritance graph
Collaboration diagram for FB::ActiveX::IDispatchAPI:
Collaboration graph

Public Member Functions

void invalidate ()
 Invalidates this object. More...
 
void getMemberNames (std::vector< std::string > &nameVector) const
 Called by the browser to enumerate the members of this JSAPI object. More...
 
size_t getMemberCount () const
 Gets the member count. More...
 
bool HasMethod (const std::string &methodName) const
 Query if the JSAPI object has the 'methodName' method. More...
 
bool HasMethod (const std::wstring &methodName) const
 
bool HasProperty (const std::string &propertyName) const
 Query if 'propertyName' is a valid property. More...
 
bool HasProperty (const std::wstring &propertyName) const
 
bool HasProperty (int idx) const
 Query if the property at "idx" exists. More...
 
FB::variant GetProperty (const std::string &propertyName)
 Gets a property value. More...
 
void SetProperty (const std::string &propertyName, const FB::variant &value)
 Sets the value of a property. More...
 
void RemoveProperty (const std::string &propertyName)
 Removes a property. More...
 
FB::variant GetProperty (int idx)
 Gets the value of an indexed property. More...
 
void SetProperty (int idx, const FB::variant &value)
 Sets the value of an indexed property. More...
 
void RemoveProperty (int idx)
 Removes an indexed property. More...
 
virtual FB::JSAPIPtr getJSAPI () const
 Get associated FB::JSAPI. More...
 
- Public Member Functions inherited from FB::JSObject
 JSObject (const BrowserHostPtr &h)
 Constructor. More...
 
virtual ~JSObject ()
 Finaliser. More...
 
virtual void InvokeAsync (const std::string &methodName, const std::vector< variant > &args)
 Just like Invoke, but works asynchronously. Useful for javascript callbacks and events. Can be safely called from any thread. More...
 
virtual void SetPropertyAsync (const std::string &propertyName, const variant &value)
 Just like SetProperty, but works asynchronously. Useful if you are running on another thread and don't need to wait to be sure it worked. More...
 
BrowserHostPtr getHost ()
 Get the associated FB::BrowserHost; may throw std::bad_cast. More...
 
- Public Member Functions inherited from FB::JSAPI
 JSAPI (void)
 Default constructor. More...
 
virtual ~JSAPI (void)
 Finaliser. More...
 
virtual void shutdown ()
 Called to notify the object that the plugin is shutting down. More...
 
virtual void pushZone (const SecurityZone &securityLevel)
 Pushes a new security level and locks a mutex (for every Push there must be a Pop!) More...
 
virtual void popZone ()
 Pops off a security level and unlocks the mutex (for every Push there must be a Pop!) More...
 
virtual void setDefaultZone (const SecurityZone &securityLevel)
 Sets the default zone (the zone the class operates on before a push) More...
 
virtual SecurityZone getDefaultZone () const
 Gets the default zone (the zone the class operates on before a push) More...
 
virtual SecurityZone getZone () const
 Gets the currently active zone. More...
 
virtual void registerEventMethod (const std::string &name, JSObjectPtr &event)
 Called by the browser to register an event handler method. More...
 
virtual void registerEventMethod (const std::wstring &name, JSObjectPtr &event)
 
virtual void unregisterEventMethod (const std::string &name, JSObjectPtr &event)
 Called by the browser to unregister an event handler method. More...
 
virtual void unregisterEventMethod (const std::wstring &name, JSObjectPtr &event)
 
virtual void registerEventInterface (const JSObjectPtr &event)
 Called by the browser to register a JSObject interface that handles events. This is primarily used by IE. Objects provided to this method are called when events are fired by calling a method of the event name on the event interface. More...
 
virtual void unregisterEventInterface (const JSObjectPtr &event)
 Called by the browser to unregister a JSObject interface that handles events. More...
 
virtual bool HasMethodObject (const std::wstring &methodObjName) const
 
virtual bool HasMethodObject (const std::string &methodObjName) const
 Query if 'methodObjName' is a valid methodObj. More...
 
virtual JSAPIPtr GetMethodObject (const std::wstring &methodObjName)
 
virtual JSAPIPtr GetMethodObject (const std::string &methodObjName)
 Gets a method object (JSAPI object that has a default method) More...
 
virtual variant GetProperty (const std::wstring &propertyName)
 
virtual void SetProperty (const std::wstring &propertyName, const variant &value)
 
virtual void RemoveProperty (const std::wstring &propertyName)
 
virtual variant Invoke (const std::wstring &methodName, const std::vector< variant > &args)
 
virtual variant Invoke (const std::string &methodName, const std::vector< variant > &args)=0
 Called by the browser to invoke a method on the JSAPI object. More...
 
virtual variant Construct (const std::vector< variant > &args)=0
 Called by the browser to construct the JSAPI object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FB::JSObject
template<class Cont >
static void GetArrayValues (const FB::JSObjectPtr &src, Cont &dst)
 Gets Array values out of src and adds them to the STL container dst. More...
 
template<class Dict >
static void GetObjectValues (const FB::JSObjectPtr &src, Dict &dst)
 Gets object values out of the javscript object src and adds them to the STL Dict container dst. More...
 

Detailed Description

Provide a JSObject implementation to wrap a IDispatch ActiveX object.

Definition at line 33 of file IDispatchAPI.h.


The documentation for this class was generated from the following files: