The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::Win32HTMLBrowser Class Reference

Class Win32HTMLBrowser documentation. More...

#include <Win32HTMLBrowser.h>

Inheritance diagram for VCF::Win32HTMLBrowser:

List of all members.

Public Member Functions
	Win32HTMLBrowser ()
virtual	~Win32HTMLBrowser ()
virtual void	create (VCF::Control *owningControl)
	This is called to actually create any neccessary windowing system resources specific to a new control (or widget/window/etc) instance for the platform.
virtual void	setFocused ()
virtual CreateParams	createParams ()
	called before the create window is called.
virtual void	setVisible (const bool &val)
	shows or hides the component.
virtual bool	handleEventMessages (UINT message, WPARAM wParam, LPARAM lParam, LRESULT &wndResult, WNDPROC defaultWndProc=NULL)
	returns true if no further handling is required, otherwise returns false, which means the rest of the handling needs to be done by the default wnd proc.
virtual String	getCurrentURL ()
virtual void	setCurrentURL (const String &url)
virtual void	goBack ()
virtual void	goForward ()
virtual void	goHome ()
virtual void	refresh ()
virtual bool	isLoadingURL ()
virtual void	stopLoadingURL ()
virtual void	setFromHTML (const String &html)
virtual String	getTitle ()
virtual void	edit (const bool &val)
virtual void	copy ()
virtual void	selectAll ()
virtual void	setAllowsPopupWindows (bool val)
virtual void	setAllowsScrollbars (bool val)
virtual void	setAllowsTextSelection (bool val)
virtual String	getElementHTMLText (const String &elementName)
virtual void	setElementHTMLText (const String &elementName, const String &html)
virtual String	getElementText (const String &elementName)
virtual void	setElementText (const String &elementName, const String &text)
virtual String	getActiveElementID ()
virtual String	getElementIDFromPoint (Point *pt)
virtual bool	setElementClickedEventHandler (const String &elementName, EventHandler *handler)
virtual HTMLDocument	getDocument ()
virtual void	onDownloadComplete ()
virtual void	onProgressChange (long x, long y)
virtual void	onStatusTextChange (BSTR val)
virtual void	onDownloadBegin ()
virtual void	onTitleChange (BSTR Text)
virtual void	onBeforeNavigate2 (LPDISPATCH pDisp, VARIANT *URL, VARIANT *Flags, VARIANT *TargetFrameName, VARIANT *PostData, VARIANT *Headers, VARIANT_BOOL *Cancel)
virtual void	onNewWindow2 (LPDISPATCH *ppDisp, VARIANT_BOOL *Cancel)
virtual void	onDocumentComplete (LPDISPATCH pDisp, VARIANT *URL)
virtual void	onWindowClosing (VARIANT_BOOL IsChildWindow, VARIANT_BOOL *Cancel)
virtual void	onFileDownload (VARIANT_BOOL *Cancel)
virtual void	onNavigateError (LPDISPATCH pDisp, VARIANT *URL, VARIANT *Frame, VARIANT *StatusCode, VARIANT_BOOL *Cancel)
HTMLEventHandler *	getElementEventHandler (const String &name)
Protected Member Functions
String	getElementText (bool textIsHTML, const String &elementName)
void	setElementText (bool textIsHTML, const String &elementName, const String &text)
void	clearHTMLHandlers ()
bool	processMessageFilter (MSG *msg)
void	handleBrowserMessages (MSG *msg)
Static Protected Member Functions
static bool	msgFilter (MSG *msg, void *data)
static LRESULT CALLBACK	browserWndProc (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
Protected Attributes
String	loadingURL_
HWND	browserHwnd_
std::map< String, HTMLEventHandler * >	eventHandlers_
com_ptr< IOleInPlaceActiveObject >	inPlaceObj_
int	msgFilterID_
WNDPROC	oldBrowserWndProc_

---

Detailed Description

Class Win32HTMLBrowser documentation.

---

Constructor & Destructor Documentation

VCF::Win32HTMLBrowser::Win32HTMLBrowser (   )

virtual VCF::Win32HTMLBrowser::~Win32HTMLBrowser (   )  [virtual]

---

Member Function Documentation

static LRESULT CALLBACK VCF::Win32HTMLBrowser::browserWndProc (  HWND  hWnd, UINT  message, WPARAM  wParam, LPARAM  lParam )  [static, protected]

void VCF::Win32HTMLBrowser::clearHTMLHandlers (   )  [inline, protected]

virtual void VCF::Win32HTMLBrowser::copy (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::create (  VCF::Control *  owningControl  )  [virtual]

This is called to actually create any neccessary windowing system resources specific to a new control (or widget/window/etc) instance for the platform. create() must be called by the containing VCF::Control subclass, typically in the classes constructor, after retreiving the new peer instance from the appropriate UIToolkit::createXXX() call. Reimplemented from VCF::AbstractWin32Component.

virtual CreateParams VCF::Win32HTMLBrowser::createParams (   )  [virtual]

called before the create window is called. Overide this to change the style and style ex parameters. Returns a pair, the pair.first is the style parameter, the pair.second is the style ex paramater. Reimplemented from VCF::Win32Object.

virtual void VCF::Win32HTMLBrowser::edit (  const bool &  val  )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual String VCF::Win32HTMLBrowser::getActiveElementID (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual String VCF::Win32HTMLBrowser::getCurrentURL (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual HTMLDocument VCF::Win32HTMLBrowser::getDocument (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

HTMLEventHandler* VCF::Win32HTMLBrowser::getElementEventHandler (  const String &  name  )  [inline]

virtual String VCF::Win32HTMLBrowser::getElementHTMLText (  const String &  elementName  )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual String VCF::Win32HTMLBrowser::getElementIDFromPoint (  Point *  pt  )  [virtual]

Implements VCF::HTMLBrowserPeer.

String VCF::Win32HTMLBrowser::getElementText (  bool  textIsHTML, const String &  elementName )  [protected]

virtual String VCF::Win32HTMLBrowser::getElementText (  const String &  elementName  )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual String VCF::Win32HTMLBrowser::getTitle (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::goBack (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::goForward (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::goHome (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

void VCF::Win32HTMLBrowser::handleBrowserMessages (  MSG *  msg  )  [protected]

virtual bool VCF::Win32HTMLBrowser::handleEventMessages (  UINT  message, WPARAM  wParam, LPARAM  lParam, LRESULT &  wndResult, WNDPROC  defaultWndProc = NULL )  [virtual]

returns true if no further handling is required, otherwise returns false, which means the rest of the handling needs to be done by the default wnd proc. Reimplemented from VCF::AbstractWin32Component.

virtual bool VCF::Win32HTMLBrowser::isLoadingURL (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

static bool VCF::Win32HTMLBrowser::msgFilter (  MSG *  msg, void *  data )  [static, protected]

virtual void VCF::Win32HTMLBrowser::onBeforeNavigate2 (  LPDISPATCH  pDisp, VARIANT *  URL, VARIANT *  Flags, VARIANT *  TargetFrameName, VARIANT *  PostData, VARIANT *  Headers, VARIANT_BOOL *  Cancel )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onDocumentComplete (  LPDISPATCH  pDisp, VARIANT *  URL )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onDownloadBegin (   )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onDownloadComplete (   )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onFileDownload (  VARIANT_BOOL *  Cancel  )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onNavigateError (  LPDISPATCH  pDisp, VARIANT *  URL, VARIANT *  Frame, VARIANT *  StatusCode, VARIANT_BOOL *  Cancel )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onNewWindow2 (  LPDISPATCH *  ppDisp, VARIANT_BOOL *  Cancel )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onProgressChange (  long  x, long  y )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onStatusTextChange (  BSTR  val  )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onTitleChange (  BSTR  Text  )  [virtual]

Reimplemented from WebBrowserCtrl.

virtual void VCF::Win32HTMLBrowser::onWindowClosing (  VARIANT_BOOL  IsChildWindow, VARIANT_BOOL *  Cancel )  [virtual]

Reimplemented from WebBrowserCtrl.

bool VCF::Win32HTMLBrowser::processMessageFilter (  MSG *  msg  )  [protected]

virtual void VCF::Win32HTMLBrowser::refresh (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::selectAll (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::setAllowsPopupWindows (  bool  val  )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::setAllowsScrollbars (  bool  val  )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::setAllowsTextSelection (  bool  val  )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::setCurrentURL (  const String &  url  )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual bool VCF::Win32HTMLBrowser::setElementClickedEventHandler (  const String &  elementName, EventHandler *  handler )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::setElementHTMLText (  const String &  elementName, const String &  html )  [virtual]

Implements VCF::HTMLBrowserPeer.

void VCF::Win32HTMLBrowser::setElementText (  bool  textIsHTML, const String &  elementName, const String &  text )  [protected]

virtual void VCF::Win32HTMLBrowser::setElementText (  const String &  elementName, const String &  text )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::setFocused (   )  [virtual]

Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32HTMLBrowser::setFromHTML (  const String &  html  )  [virtual]

Implements VCF::HTMLBrowserPeer.

virtual void VCF::Win32HTMLBrowser::setVisible (  const bool &  val  )  [virtual]

shows or hides the component. This does NOT close the component (if invoked on a frame based component ). Reimplemented from VCF::AbstractWin32Component.

virtual void VCF::Win32HTMLBrowser::stopLoadingURL (   )  [virtual]

Implements VCF::HTMLBrowserPeer.

---

Member Data Documentation

HWND VCF::Win32HTMLBrowser::browserHwnd_ [protected]

std::map<String,HTMLEventHandler*> VCF::Win32HTMLBrowser::eventHandlers_ [protected]

com_ptr<IOleInPlaceActiveObject> VCF::Win32HTMLBrowser::inPlaceObj_ [protected]

String VCF::Win32HTMLBrowser::loadingURL_ [protected]

int VCF::Win32HTMLBrowser::msgFilterID_ [protected]

WNDPROC VCF::Win32HTMLBrowser::oldBrowserWndProc_ [protected]

---

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

• vcf/HTMLKit/Win32HTMLBrowser.h

Comments or Suggestions?    License Information