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

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

#ifdef __GNUG__
    #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" wxWindows 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) == "myVFS");
}


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

    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>",
                 location.GetData(), location.GetData(), location.GetData(), location.GetData());

    // 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, "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 OnAbout(wxCommandEvent& event);
      void OnBack(wxCommandEvent& event);
      void OnForward(wxCommandEvent& event);

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

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

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

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

// the event tables connect the wxWindows 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_About, MyFrame::OnAbout)
   EVT_MENU(Minimal_Back, MyFrame::OnBack)
   EVT_MENU(Minimal_Forward, MyFrame::OnForward)
   END_EVENT_TABLE()
   
   // Create a new application object: this macro will allow wxWindows 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",
         wxPoint(50, 50), 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, -1, 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);
   
      CreateStatusBar(2);

      html = new wxHtmlWindow(this);
      html -> SetRelatedFrame(this, "VFS Demo: '%s'");
      html -> SetRelatedStatusBar(1);
      html -> LoadPage("start.htm");
   }


// event handlers

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

   void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
   {
   }


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