Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-06-27 16:22:58 +00:00
parent 92b6654b66
commit ae3c17b401
277 changed files with 0 additions and 0 deletions
--- a/interface/wx/fs_mem.h
+++ b/interface/wx/fs_mem.h
@@ -0,0 +1,116 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        fs_mem.h
+// Purpose:     interface of wxMemoryFSHandler
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxMemoryFSHandler
+    @wxheader{fs_mem.h}
+
+    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 @c "memory:", e.g. @c "memory:myfile.html".
+
+    Example:
+
+    @code
+    #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");
+    }
+    @endcode
+
+    @library{wxbase}
+    @category{vfs}
+
+    @see wxMemoryFSHandler::AddFileWithMimeType
+*/
+class wxMemoryFSHandler : public wxFileSystemHandler
+{
+public:
+    /**
+        Constructor.
+    */
+    wxMemoryFSHandler();
+
+    //@{
+    /**
+        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 @c "memory:" + @e filename.
+
+        @note you must use a @a type value (aka image format) that wxWidgets
+              can save (e.g. JPG, PNG, see wxImage documentation)!
+
+        @see AddFileWithMimeType()
+    */
+    static void AddFile(const wxString& filename, wxImage& image, wxBitmapType type);
+    static void AddFile(const wxString& filename, const wxBitmap& bitmap, wxBitmapType type);
+    //@}
+
+    //@{
+    /**
+        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 AddFile()
+    */
+    static void AddFileWithMimeType(const wxString& filename,
+                                    const wxString& textdata,
+                                    const wxString& mimetype);
+    static void AddFileWithMimeType(const wxString& filename,
+                                    const void* binarydata,
+                                    size_t size,
+                                    const wxString& mimetype);
+    //@}
+
+    /**
+        Removes a file from memory FS and frees the occupied memory.
+    */
+    static void RemoveFile(const wxString& filename);
+};
+