clarified global and local config files behavior

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

diff --git a/docs/latex/wx/fs_mem.tex b/docs/latex/wx/fs_mem.tex
index 733b6d61f8653b0b806ac0efd8ff156e2112a1bf..6ceced1ef6425bbe6ff441c5a38c1cf76ee3b79a 100644 (file)
--- a/docs/latex/wx/fs_mem.tex
+++ b/docs/latex/wx/fs_mem.tex
@@ -78,18 +78,36 @@ Constructor.
 
 \func{static void}{AddFile}{\param{const wxString\& }{filename}, \param{const wxBitmap\& }{bitmap}, \param{long }{type}}
 
 
 \func{static void}{AddFile}{\param{const wxString\& }{filename}, \param{const wxBitmap\& }{bitmap}, \param{long }{type}}
 

-\func{static void}{AddFile}{\param{const wxString\& }{filename}, \param{const wxString\& }{textdata}}
-
-\func{static void}{AddFile}{\param{const wxString\& }{filename}, \param{const void* }{binarydata}, \param{size\_t }{size}}
-

 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 
 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:" + filename.
+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}

 
 

-Note that when storing image/bitmap, you must use image format that wxWindows
-can write (e.g. JPG, PNG, see \helpref{wxImage documentation}{wximage})!
+\wxheading{See also}

 
 

+\helpref{AddFile}{wxmemoryfshandleraddfile}

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