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

/////////////////////////////////////////////////////////////////////////////
// Name:        virtual.cpp
// Purpose:     wxHtml sample: demonstrates virtual file systems feature
// Author:      ?
// Modified by:
// Created:     ?
// RCS-ID:      $Id$
// Copyright:   (c) wxWidgets team
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

// 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"

#ifndef __WXMSW__
    #include "../../sample.xpm"
#endif

// new handler class:

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


// ----------------------------------------------------------------------------
// MyVFS
// ----------------------------------------------------------------------------

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()
{
    if ( !wxApp::OnInit() )
        return false;

    // 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)
{
    SetIcon(wxICON(sample));

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