wxMemoryFSHandler Class Reference
[Virtual File System]

#include </home/work/projects/wx/2.9/wx/interface/wx/fs_mem.h>

Inheritance diagram for wxMemoryFSHandler:

Detailed Description

This wxFileSystem handler can store arbitrary data in memory stream and make them accessible via an URL.

It is particularly suitable for storing bitmaps from resources or included XPM files so that they can be used with wxHTML.

Filenames are prefixed with "memory:", e.g. "memory:myfile.html".

Example:

    #ifndef __WXMSW__
    #include "logo.xpm"
    #endif

    void MyFrame::OnAbout(wxCommandEvent&)
    {
        wxBusyCursor bcur;
        wxFileSystem::AddHandler(new wxMemoryFSHandler);
        wxMemoryFSHandler::AddFile("logo.pcx", wxBITMAP(logo), wxBITMAP_TYPE_PCX);
        wxMemoryFSHandler::AddFile("about.htm",
                                "<html><body>About: "
                                "<img src=\"memory:logo.pcx\"></body></html>");

        wxDialog dlg(this, -1, wxString(_("About")));
        wxBoxSizer *topsizer;
        wxHtmlWindow *html;
        topsizer = new wxBoxSizer(wxVERTICAL);
        html = new wxHtmlWindow(&dlg, -1, wxDefaultPosition,
                                wxSize(380, 160), wxHW_SCROLLBAR_NEVER);
        html->SetBorders(0);
        html->LoadPage("memory:about.htm");
        html->SetSize(html->GetInternalRepresentation()->GetWidth(),
                    html->GetInternalRepresentation()->GetHeight());
        topsizer->Add(html, 1, wxALL, 10);
        topsizer->Add(new wxStaticLine(&dlg, -1), 0, wxEXPAND | wxLEFT | wxRIGHT, 10);
        topsizer->Add(new wxButton(&dlg, wxID_OK, "Ok"),
                    0, wxALL | wxALIGN_RIGHT, 15);
        dlg.SetAutoLayout(true);
        dlg.SetSizer(topsizer);
        topsizer->Fit(&dlg);
        dlg.Centre();
        dlg.ShowModal();

        wxMemoryFSHandler::RemoveFile("logo.pcx");
        wxMemoryFSHandler::RemoveFile("about.htm");
    }

Library: wxBase

Category: Virtual File System

See also:: wxMemoryFSHandler::AddFileWithMimeType


Public Member Functions
	wxMemoryFSHandler ()
	Constructor.
Static Public Member Functions
static void	RemoveFile (const wxString &filename)
	Removes a file from memory FS and frees the occupied memory.

static void	AddFile (const wxString &filename, wxImage &image, wxBitmapType type)
	Adds a file to the list of the files stored in memory.
static void	AddFile (const wxString &filename, const wxBitmap &bitmap, wxBitmapType type)
	Adds a file to the list of the files stored in memory.

static void	AddFileWithMimeType (const wxString &filename, const wxString &textdata, const wxString &mimetype)
	Like AddFile(), but lets you explicitly specify added file's MIME type.
static void	AddFileWithMimeType (const wxString &filename, const void *binarydata, size_t size, const wxString &mimetype)
	Like AddFile(), but lets you explicitly specify added file's MIME type.

List of all members.

Constructor & Destructor Documentation

wxMemoryFSHandler::wxMemoryFSHandler ( )

Constructor.

Member Function Documentation

static void wxMemoryFSHandler::AddFile	(	const wxString &	filename,
		const wxBitmap &	bitmap,
		wxBitmapType	type
	)			`[static]`

Adds a file to the list of the files stored in memory.

Stored data (bitmap, text or raw data) will be copied into private memory stream and available under name "memory:" + filename.

Note:: you must use a type value (aka image format) that wxWidgets can save (e.g. JPG, PNG, see wxImage documentation)!

See also:: AddFileWithMimeType()

static void wxMemoryFSHandler::AddFile	(	const wxString &	filename,
		wxImage &	image,
		wxBitmapType	type
	)			`[static]`

Adds a file to the list of the files stored in memory.

Stored data (bitmap, text or raw data) will be copied into private memory stream and available under name "memory:" + filename.

Note:: you must use a type value (aka image format) that wxWidgets can save (e.g. JPG, PNG, see wxImage documentation)!

See also:: AddFileWithMimeType()

static void wxMemoryFSHandler::AddFileWithMimeType	(	const wxString &	filename,
		const void *	binarydata,
		size_t	size,
		const wxString &	mimetype
	)			`[static]`

Like AddFile(), but lets you explicitly specify added file's MIME type.

This version should be used whenever you know the MIME type, because it makes accessing the files faster.

Since:: 2.8.5

See also:: AddFile()

static void wxMemoryFSHandler::AddFileWithMimeType	(	const wxString &	filename,
		const wxString &	textdata,
		const wxString &	mimetype
	)			`[static]`

Like AddFile(), but lets you explicitly specify added file's MIME type.

This version should be used whenever you know the MIME type, because it makes accessing the files faster.

Since:: 2.8.5

See also:: AddFile()

static void wxMemoryFSHandler::RemoveFile ( const wxString & filename ) [static]

Removes a file from memory FS and frees the occupied memory.

wxMemoryFSHandler Class Reference [Virtual File System]

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

wxMemoryFSHandler Class Reference
[Virtual File System]