[wxWidgets.git] / samples / html / virtual / virtual.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        virtua;.cpp
// Purpose:     wxHtml testing example
//              demonstrates virtual file systems feature
/////////////////////////////////////////////////////////////////////////////

// For compilers that support precompilation, includes "wx/wx.h".
#include "wx/wxprec.h"

#ifdef __BORLANDC__
    #pragma hdrstop
#endif

// for all others, include the necessary headers (this file is usually all you
// need because it includes almost all "standard" wxWidgets headers
#ifndef WX_PRECOMP
    #include "wx/wx.h"
#endif


#include "wx/html/htmlwin.h"


// new handler class:

#include "wx/wfstream.h"
#include "wx/mstream.h"


class MyVFS : public wxFileSystemHandler
{
public:
    MyVFS() : wxFileSystemHandler() {}

    wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location);
    bool CanOpen(const wxString& location);
};


bool MyVFS::CanOpen(const wxString& location)
{
    return (GetProtocol(location) == wxT("myVFS"));
}


wxFSFile* MyVFS::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& location)
{
    wxFSFile *f;
    wxInputStream *str;
    static char buf[1024];
    const wxWX2MBbuf loc = location.ToAscii();

    sprintf(buf, "<html><body><h2><i>You're in Node <u>%s</u></i></h2><p>"
                 "Where do you want to go?<br><blockquote>"
                 "<a href=\"%s-1\">sub-1</a><br>"
                 "<a href=\"%s-2\">sub-2</a><br>"
                 "<a href=\"%s-3\">sub-3</a><br>"
                 "</blockquote></body></html>",
                 (const char*)loc, (const char*)loc, (const char*)loc, 
                 (const char*)loc);

    // NB: There's a terrible hack involved: we fill 'buf' with new data every
    //     time this method is called and return new wxMemoryInputStream pointing to it.
    //     This won't work as soon as there are 2+ myVFS files opened. Fortunately,
    //     this won't happen because wxHTML keeps only one "page" file opened at the
    //     time.
    str = new wxMemoryInputStream(buf, strlen(buf));
    f = new wxFSFile(str, location, wxT("text/html"), wxEmptyString, wxDateTime::Today());
    
    return f;
}


// ----------------------------------------------------------------------------
// private classes
// ----------------------------------------------------------------------------

// Define a new application type, each program should derive a class from wxApp
   class MyApp : public wxApp
   {
   public:
    // override base class virtuals
    // ----------------------------
   
    // this one is called on application startup and is a good place for the app
    // initialization (doing it here and not in the ctor allows to have an error
    // return: if OnInit() returns false, the application terminates)
      virtual bool OnInit();
   };

// Define a new frame type: this is going to be our main frame
   class MyFrame : public wxFrame
   {
   public:
    // ctor(s)
      MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
   
    // event handlers (these functions should _not_ be virtual)
      void OnQuit(wxCommandEvent& event);
      void OnBack(wxCommandEvent& event);
      void OnForward(wxCommandEvent& event);

   private:
    // any class wishing to process wxWidgets events must use this macro
    DECLARE_EVENT_TABLE()
   };

// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------

// IDs for the controls and the menu commands
   enum
   {
    // menu items
   Minimal_Quit = 1,
   Minimal_Back,
   Minimal_Forward,
   
    // controls start here (the numbers are, of course, arbitrary)
   Minimal_Text = 1000,
   };

// ----------------------------------------------------------------------------
// event tables and other macros for wxWidgets
// ----------------------------------------------------------------------------

// the event tables connect the wxWidgets events with the functions (event
// handlers) which process them. It can be also done at run-time, but for the
// simple menu events like this the static method is much simpler.
   BEGIN_EVENT_TABLE(MyFrame, wxFrame)
   EVT_MENU(Minimal_Quit,  MyFrame::OnQuit)
   EVT_MENU(Minimal_Back, MyFrame::OnBack)
   EVT_MENU(Minimal_Forward, MyFrame::OnForward)
   END_EVENT_TABLE()
   
   // Create a new application object: this macro will allow wxWidgets to create
   // the application object during program execution (it's better than using a
   // static object for many reasons) and also declares the accessor function
   // wxGetApp() which will return the reference of the right type (i.e. MyApp and
   // not wxApp)
   IMPLEMENT_APP(MyApp)
   
   // ============================================================================
   // implementation
   // ============================================================================
   
   // ----------------------------------------------------------------------------
   // the application class
   // ----------------------------------------------------------------------------
   
   // `Main program' equivalent: the program execution "starts" here
   bool MyApp::OnInit()
   {
    // Create the main application window
      MyFrame *frame = new MyFrame(_("wxHtmlWindow testing application"),
         wxDefaultPosition, wxSize(640, 480));

    // Show it and tell the application that it's our main window
    // @@@ what does it do exactly, in fact? is it necessary here?
      frame->Show(true);
      SetTopWindow(frame);
      wxFileSystem::AddHandler(new MyVFS);

    // success: wxApp::OnRun() will be called which will enter the main message
    // loop and the application will run. If we returned false here, the
    // application would exit immediately.
      return true;
   }

// ----------------------------------------------------------------------------
// main frame
// ----------------------------------------------------------------------------

wxHtmlWindow *html;

// frame constructor
   MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
   : wxFrame((wxFrame *)NULL, wxID_ANY, title, pos, size)
   {
    // create a menu bar
      wxMenu *menuFile = new wxMenu;
      wxMenu *menuNav = new wxMenu;

      menuFile->Append(Minimal_Quit, _("E&xit"));
      menuNav->Append(Minimal_Back, _("Go &BACK"));
      menuNav->Append(Minimal_Forward, _("Go &FORWARD"));

    // now append the freshly created menu to the menu bar...
      wxMenuBar *menuBar = new wxMenuBar;
      menuBar->Append(menuFile, _("&File"));
      menuBar->Append(menuNav, _("&Navigate"));

    // ... and attach this menu bar to the frame
      SetMenuBar(menuBar);
   
#if wxUSE_STATUSBAR
      CreateStatusBar(2);
#endif // wxUSE_STATUSBAR

      html = new wxHtmlWindow(this);
      html -> SetRelatedFrame(this, _("VFS Demo: '%s'"));
#if wxUSE_STATUSBAR
      html -> SetRelatedStatusBar(1);
#endif // wxUSE_STATUSBAR
      html -> LoadPage(wxT("start.htm"));
   }


// event handlers

   void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
   {
    // true is to force the frame to close
      Close(true);
   }

   void MyFrame::OnBack(wxCommandEvent& WXUNUSED(event))
   {
   if (!html -> HistoryBack()) wxMessageBox(_("You reached prehistory era!"));
   }


   void MyFrame::OnForward(wxCommandEvent& WXUNUSED(event))
   {
   if (!html -> HistoryForward()) wxMessageBox(_("No more items in history!"));
   }
Commit	Line	Data
5526e819 VS	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: virtua;.cpp
	3	// Purpose: wxHtml testing example
	4	// demonstrates virtual file systems feature
	5	/////////////////////////////////////////////////////////////////////////////
	6
5526e819	7	// For compilers that support precompilation, includes "wx/wx.h".
92a19c2e	8	#include "wx/wxprec.h"
5526e819 VS	9
	10	#ifdef __BORLANDC__
	11	#pragma hdrstop
	12	#endif
	13
	14	// for all others, include the necessary headers (this file is usually all you
be5a51fb	15	// need because it includes almost all "standard" wxWidgets headers
5526e819	16	#ifndef WX_PRECOMP
67547666	17	#include "wx/wx.h"
5526e819 VS	18	#endif
	19
	20
67547666	21	#include "wx/html/htmlwin.h"
5526e819 VS	22
	23
	24	// new handler class:
	25
67547666 GD	26	#include "wx/wfstream.h"
67547666 GD	27	#include "wx/mstream.h"
5526e819 VS	28
	29
	30
	31	class MyVFS : public wxFileSystemHandler
	32	{
	33	public:
	34	MyVFS() : wxFileSystemHandler() {}
	35
	36	wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location);
	37	bool CanOpen(const wxString& location);
	38	};
	39
	40
	41	bool MyVFS::CanOpen(const wxString& location)
	42	{
2b5f62a0	43	return (GetProtocol(location) == wxT("myVFS"));
5526e819 VS	44	}
	45
	46
	47
87728739	48	wxFSFile* MyVFS::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& location)
5526e819 VS	49	{
	50	wxFSFile *f;
	51	wxInputStream *str;
2bc524f3	52	static char buf[1024];
2b5f62a0	53	const wxWX2MBbuf loc = location.ToAscii();
5526e819 VS	54
	55	sprintf(buf, "<html><body><h2><i>You're in Node <u>%s</u></i></h2><p>"
	56	"Where do you want to go?<br><blockquote>"
	57	"<a href=\"%s-1\">sub-1</a><br>"
	58	"<a href=\"%s-2\">sub-2</a><br>"
	59	"<a href=\"%s-3\">sub-3</a><br>"
	60	"</blockquote></body></html>",
2b5f62a0 VZ	61	(const char)loc, (const char)loc, (const char*)loc,
2b5f62a0 VZ	62	(const char*)loc);
7e1e0960	63
2bc524f3 VS	64	// NB: There's a terrible hack involved: we fill 'buf' with new data every
	65	// time this method is called and return new wxMemoryInputStream pointing to it.
	66	// This won't work as soon as there are 2+ myVFS files opened. Fortunately,
	67	// this won't happen because wxHTML keeps only one "page" file opened at the
	68	// time.
5526e819	69	str = new wxMemoryInputStream(buf, strlen(buf));
2b5f62a0	70	f = new wxFSFile(str, location, wxT("text/html"), wxEmptyString, wxDateTime::Today());
2bc524f3	71
5526e819 VS	72	return f;
	73	}
	74
	75
	76
	77	// ----------------------------------------------------------------------------
	78	// private classes
	79	// ----------------------------------------------------------------------------
	80
	81	// Define a new application type, each program should derive a class from wxApp
	82	class MyApp : public wxApp
	83	{
	84	public:
	85	// override base class virtuals
	86	// ----------------------------
	87
	88	// this one is called on application startup and is a good place for the app
	89	// initialization (doing it here and not in the ctor allows to have an error
	90	// return: if OnInit() returns false, the application terminates)
	91	virtual bool OnInit();
	92	};
	93
	94	// Define a new frame type: this is going to be our main frame
	95	class MyFrame : public wxFrame
	96	{
	97	public:
	98	// ctor(s)
	99	MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
	100
	101	// event handlers (these functions should _not_ be virtual)
	102	void OnQuit(wxCommandEvent& event);
5526e819 VS	103	void OnBack(wxCommandEvent& event);
	104	void OnForward(wxCommandEvent& event);
	105
	106	private:
be5a51fb	107	// any class wishing to process wxWidgets events must use this macro
5526e819 VS	108	DECLARE_EVENT_TABLE()
	109	};
	110
	111	// ----------------------------------------------------------------------------
	112	// constants
	113	// ----------------------------------------------------------------------------
	114
	115	// IDs for the controls and the menu commands
	116	enum
	117	{
	118	// menu items
	119	Minimal_Quit = 1,
5526e819 VS	120	Minimal_Back,
	121	Minimal_Forward,
	122
	123	// controls start here (the numbers are, of course, arbitrary)
	124	Minimal_Text = 1000,
	125	};
	126
	127	// ----------------------------------------------------------------------------
be5a51fb	128	// event tables and other macros for wxWidgets
5526e819 VS	129	// ----------------------------------------------------------------------------
5526e819 VS	130
be5a51fb	131	// the event tables connect the wxWidgets events with the functions (event
5526e819 VS	132	// handlers) which process them. It can be also done at run-time, but for the
	133	// simple menu events like this the static method is much simpler.
	134	BEGIN_EVENT_TABLE(MyFrame, wxFrame)
	135	EVT_MENU(Minimal_Quit, MyFrame::OnQuit)
5526e819 VS	136	EVT_MENU(Minimal_Back, MyFrame::OnBack)
	137	EVT_MENU(Minimal_Forward, MyFrame::OnForward)
	138	END_EVENT_TABLE()
	139
be5a51fb	140	// Create a new application object: this macro will allow wxWidgets to create
5526e819 VS	141	// the application object during program execution (it's better than using a
	142	// static object for many reasons) and also declares the accessor function
	143	// wxGetApp() which will return the reference of the right type (i.e. MyApp and
	144	// not wxApp)
	145	IMPLEMENT_APP(MyApp)
	146
	147	// ============================================================================
	148	// implementation
	149	// ============================================================================
	150
	151	// ----------------------------------------------------------------------------
	152	// the application class
	153	// ----------------------------------------------------------------------------
	154
	155	// `Main program' equivalent: the program execution "starts" here
	156	bool MyApp::OnInit()
	157	{
	158	// Create the main application window
2b5f62a0	159	MyFrame *frame = new MyFrame(_("wxHtmlWindow testing application"),
16f26dad	160	wxDefaultPosition, wxSize(640, 480));
aec18ff7	161
5526e819 VS	162	// Show it and tell the application that it's our main window
5526e819 VS	163	// @@@ what does it do exactly, in fact? is it necessary here?
348469c2	164	frame->Show(true);
5526e819 VS	165	SetTopWindow(frame);
5526e819 VS	166	wxFileSystem::AddHandler(new MyVFS);
aec18ff7	167
5526e819	168	// success: wxApp::OnRun() will be called which will enter the main message
348469c2	169	// loop and the application will run. If we returned false here, the
5526e819	170	// application would exit immediately.
348469c2	171	return true;
5526e819 VS	172	}
	173
	174	// ----------------------------------------------------------------------------
	175	// main frame
	176	// ----------------------------------------------------------------------------
	177
	178	wxHtmlWindow *html;
	179
	180	// frame constructor
	181	MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
348469c2	182	: wxFrame((wxFrame *)NULL, wxID_ANY, title, pos, size)
5526e819 VS	183	{
	184	// create a menu bar
	185	wxMenu *menuFile = new wxMenu;
	186	wxMenu *menuNav = new wxMenu;
	187
2b5f62a0 VZ	188	menuFile->Append(Minimal_Quit, _("E&xit"));
	189	menuNav->Append(Minimal_Back, _("Go &BACK"));
	190	menuNav->Append(Minimal_Forward, _("Go &FORWARD"));
5526e819 VS	191
	192	// now append the freshly created menu to the menu bar...
	193	wxMenuBar *menuBar = new wxMenuBar;
2b5f62a0 VZ	194	menuBar->Append(menuFile, _("&File"));
2b5f62a0 VZ	195	menuBar->Append(menuNav, _("&Navigate"));
5526e819 VS	196
	197	// ... and attach this menu bar to the frame
	198	SetMenuBar(menuBar);
	199
8520f137	200	#if wxUSE_STATUSBAR
9eeb92ac	201	CreateStatusBar(2);
8520f137	202	#endif // wxUSE_STATUSBAR
5526e819 VS	203
5526e819 VS	204	html = new wxHtmlWindow(this);
2b5f62a0	205	html -> SetRelatedFrame(this, _("VFS Demo: '%s'"));
8520f137	206	#if wxUSE_STATUSBAR
5526e819	207	html -> SetRelatedStatusBar(1);
8520f137	208	#endif // wxUSE_STATUSBAR
2b5f62a0	209	html -> LoadPage(wxT("start.htm"));
5526e819 VS	210	}
	211
	212
	213	// event handlers
	214
	215	void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
	216	{
348469c2 WS	217	// true is to force the frame to close
348469c2 WS	218	Close(true);
5526e819 VS	219	}
5526e819 VS	220
5526e819 VS	221	void MyFrame::OnBack(wxCommandEvent& WXUNUSED(event))
5526e819 VS	222	{
2b5f62a0	223	if (!html -> HistoryBack()) wxMessageBox(_("You reached prehistory era!"));
5526e819 VS	224	}
	225
	226
	227	void MyFrame::OnForward(wxCommandEvent& WXUNUSED(event))
	228	{
2b5f62a0	229	if (!html -> HistoryForward()) wxMessageBox(_("No more items in history!"));
5526e819	230	}