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

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

#if defined(__GNUG__) && !defined(__APPLE__)
    #pragma implementation "test.cpp"
    #pragma interface "test.cpp"
#endif

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