[wxWidgets.git] / docs / latex / wx / fs_mem.tex

%
% automatically generated by HelpGen from
% /home/vasek/fs\_mem.h at 27/Feb/00 19:23:10
%

\section{\class{wxMemoryFSHandler}}\label{wxmemoryfshandler}

This \helpref{wxFileSystem}{wxfilesystem} handler can store arbitrary 
data in memory stream and make them accessible via 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:

\begin{verbatim}
#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");
}
\end{verbatim}


\wxheading{Derived from}

\helpref{wxFileSystemHandler}{wxfilesystemhandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/fs\_mem.h>

\wxheading{Library}

\helpref{wxBase}{librarieslist}


\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{wxMemoryFSHandler::wxMemoryFSHandler}\label{wxmemoryfshandlerwxmemoryfshandler}

\func{}{wxMemoryFSHandler}{\void}

Constructor.

\membersection{wxMemoryFSHandler::AddFile}\label{wxmemoryfshandleraddfile}

\func{static void}{AddFile}{\param{const wxString\& }{filename}, \param{wxImage\& }{image}, \param{long }{type}}

\func{static void}{AddFile}{\param{const wxString\& }{filename}, \param{const wxBitmap\& }{bitmap}, \param{long }{type}}

Add file to list of files stored in memory. Stored 
data (bitmap, text or raw data)
will be copied into private memory stream and available under 
name "memory:" + \arg{filename}.

The \arg{type} argument is one of {\tt wxBITMAP\_TYPE\_XXX} constants.
Note that you must use a \arg{type} value (aka image format)
that wxWidgets can save (e.g. JPG, PNG, see \helpref{wxImage
documentation}{wximage})!

\wxheading{See also}

\helpref{AddFileWithMimeType}{wxmemoryfshandleraddfilewithmimetype}


\membersection{wxMemoryFSHandler::AddFileWithMimeType}\label{wxmemoryfshandleraddfilewithmimetype}

\func{static void}{AddFileWithMimeType}{\param{const wxString\& }{filename}, \param{const wxString\& }{textdata}, \param{const wxString\& }{mimetype}}

\func{static void}{AddFileWithMimeType}{\param{const wxString\& }{filename}, \param{const void* }{binarydata}, \param{size\_t }{size}, \param{const wxString\& }{mimetype}}

Like \helpref{AddFile}{wxmemoryfshandleraddfile}, 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.

\newsince{2.8.5}

\wxheading{See also}

\helpref{AddFile}{wxmemoryfshandleraddfile}

\membersection{wxMemoryFSHandler::RemoveFile}\label{wxmemoryfshandlerremovefile}

\func{static void}{RemoveFile}{\param{const wxString\& }{filename}}

Remove file from memory FS and free occupied memory.
Commit	Line	Data
dbddf573 VS	1	%
	2	% automatically generated by HelpGen from
	3	% /home/vasek/fs\_mem.h at 27/Feb/00 19:23:10
	4	%
	5
	6	\section{\class{wxMemoryFSHandler}}\label{wxmemoryfshandler}
	7
	8	This \helpref{wxFileSystem}{wxfilesystem} handler can store arbitrary
	9	data in memory stream and make them accessible via URL. It is particularly
	10	suitable for storing bitmaps from resources or included XPM files so that
	11	they can be used with wxHTML.
	12
	13	Filenames are prefixed with "memory:", e.g. "memory:myfile.html".
	14
	15	Example:
	16
	17	\begin{verbatim}
	18	#ifndef __WXMSW__
	19	#include "logo.xpm"
	20	#endif
	21
	22	void MyFrame::OnAbout(wxCommandEvent&)
	23	{
	24	wxBusyCursor bcur;
2b5f62a0	25	wxFileSystem::AddHandler(new wxMemoryFSHandler);
dbddf573 VS	26	wxMemoryFSHandler::AddFile("logo.pcx", wxBITMAP(logo), wxBITMAP_TYPE_PCX);
	27	wxMemoryFSHandler::AddFile("about.htm",
	28	"<html><body>About: "
	29	"<img src=\"memory:logo.pcx\"></body></html>");
	30
	31	wxDialog dlg(this, -1, wxString(_("About")));
	32	wxBoxSizer *topsizer;
	33	wxHtmlWindow *html;
	34	topsizer = new wxBoxSizer(wxVERTICAL);
	35	html = new wxHtmlWindow(&dlg, -1, wxDefaultPosition,
	36	wxSize(380, 160), wxHW_SCROLLBAR_NEVER);
	37	html->SetBorders(0);
	38	html->LoadPage("memory:about.htm");
	39	html->SetSize(html->GetInternalRepresentation()->GetWidth(),
	40	html->GetInternalRepresentation()->GetHeight());
	41	topsizer->Add(html, 1, wxALL, 10);
	42	topsizer->Add(new wxStaticLine(&dlg, -1), 0, wxEXPAND \| wxLEFT \| wxRIGHT, 10);
	43	topsizer->Add(new wxButton(&dlg, wxID_OK, "Ok"),
	44	0, wxALL \| wxALIGN_RIGHT, 15);
	45	dlg.SetAutoLayout(true);
	46	dlg.SetSizer(topsizer);
	47	topsizer->Fit(&dlg);
	48	dlg.Centre();
	49	dlg.ShowModal();
	50
	51	wxMemoryFSHandler::RemoveFile("logo.pcx");
	52	wxMemoryFSHandler::RemoveFile("about.htm");
	53	}
	54	\end{verbatim}
	55
	56
	57	\wxheading{Derived from}
	58
7376079d VZ	59	\helpref{wxFileSystemHandler}{wxfilesystemhandler}\\
7376079d VZ	60	\helpref{wxObject}{wxobject}
dbddf573 VS	61
	62	\wxheading{Include files}
	63
e7240349	64	<wx/fs\_mem.h>
dbddf573	65
a7af285d VZ	66	\wxheading{Library}
	67
	68	\helpref{wxBase}{librarieslist}
	69
dbddf573 VS	70
	71	\latexignore{\rtfignore{\wxheading{Members}}}
	72
	73
	74	\membersection{wxMemoryFSHandler::wxMemoryFSHandler}\label{wxmemoryfshandlerwxmemoryfshandler}
	75
	76	\func{}{wxMemoryFSHandler}{\void}
	77
	78	Constructor.
	79
	80	\membersection{wxMemoryFSHandler::AddFile}\label{wxmemoryfshandleraddfile}
	81
	82	\func{static void}{AddFile}{\param{const wxString\& }{filename}, \param{wxImage\& }{image}, \param{long }{type}}
	83
	84	\func{static void}{AddFile}{\param{const wxString\& }{filename}, \param{const wxBitmap\& }{bitmap}, \param{long }{type}}
	85
dbddf573 VS	86	Add file to list of files stored in memory. Stored
	87	data (bitmap, text or raw data)
	88	will be copied into private memory stream and available under
54ab3bb8	89	name "memory:" + \arg{filename}.
dbddf573	90
54ab3bb8 VS	91	The \arg{type} argument is one of {\tt wxBITMAP\_TYPE\_XXX} constants.
	92	Note that you must use a \arg{type} value (aka image format)
	93	that wxWidgets can save (e.g. JPG, PNG, see \helpref{wxImage
	94	documentation}{wximage})!
dbddf573	95
35fc0be7 VS	96	\wxheading{See also}
	97
	98	\helpref{AddFileWithMimeType}{wxmemoryfshandleraddfilewithmimetype}
	99
	100
	101	\membersection{wxMemoryFSHandler::AddFileWithMimeType}\label{wxmemoryfshandleraddfilewithmimetype}
	102
	103	\func{static void}{AddFileWithMimeType}{\param{const wxString\& }{filename}, \param{const wxString\& }{textdata}, \param{const wxString\& }{mimetype}}
	104
	105	\func{static void}{AddFileWithMimeType}{\param{const wxString\& }{filename}, \param{const void* }{binarydata}, \param{size\_t }{size}, \param{const wxString\& }{mimetype}}
	106
	107	Like \helpref{AddFile}{wxmemoryfshandleraddfile}, but lets you explicitly
	108	specify added file's MIME type. This version should be used whenever you know
	109	the MIME type, because it makes accessing the files faster.
	110
	111	\newsince{2.8.5}
	112
	113	\wxheading{See also}
	114
	115	\helpref{AddFile}{wxmemoryfshandleraddfile}
dbddf573 VS	116
	117	\membersection{wxMemoryFSHandler::RemoveFile}\label{wxmemoryfshandlerremovefile}
	118
	119	\func{static void}{RemoveFile}{\param{const wxString\& }{filename}}
	120
	121	Remove file from memory FS and free occupied memory.
	122