interface/wx/fs_mem.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        fs_mem.h
   3 // Purpose:     interface of wxMemoryFSHandler
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxMemoryFSHandler
  11
  12     This wxFileSystem handler can store arbitrary data in memory stream and make
  13     them accessible via an URL.
  14
  15     It is particularly suitable for storing bitmaps from resources or included XPM
  16     files so that they can be used with wxHTML.
  17
  18     Filenames are prefixed with @c "memory:", e.g. @c "memory:myfile.html".
  19
  20     Example:
  21
  22     @code
  23     #ifndef __WXMSW__
  24     #include "logo.xpm"
  25     #endif
  26
  27     void MyFrame::OnAbout(wxCommandEvent&)
  28     {
  29         wxBusyCursor bcur;
  30         wxFileSystem::AddHandler(new wxMemoryFSHandler);
  31         wxMemoryFSHandler::AddFile("logo.pcx", wxBITMAP(logo), wxBITMAP_TYPE_PCX);
  32         wxMemoryFSHandler::AddFile("about.htm",
  33                                 "<html><body>About: "
  34                                 "<img src=\"memory:logo.pcx\"></body></html>");
  35
  36         wxDialog dlg(this, -1, wxString(_("About")));
  37         wxBoxSizer *topsizer;
  38         wxHtmlWindow *html;
  39         topsizer = new wxBoxSizer(wxVERTICAL);
  40         html = new wxHtmlWindow(&dlg, -1, wxDefaultPosition,
  41                                 wxSize(380, 160), wxHW_SCROLLBAR_NEVER);
  42         html->SetBorders(0);
  43         html->LoadPage("memory:about.htm");
  44         html->SetSize(html->GetInternalRepresentation()->GetWidth(),
  45                     html->GetInternalRepresentation()->GetHeight());
  46         topsizer->Add(html, 1, wxALL, 10);
  47         topsizer->Add(new wxStaticLine(&dlg, -1), 0, wxEXPAND | wxLEFT | wxRIGHT, 10);
  48         topsizer->Add(new wxButton(&dlg, wxID_OK, "Ok"),
  49                     0, wxALL | wxALIGN_RIGHT, 15);
  50         dlg.SetAutoLayout(true);
  51         dlg.SetSizer(topsizer);
  52         topsizer->Fit(&dlg);
  53         dlg.Centre();
  54         dlg.ShowModal();
  55
  56         wxMemoryFSHandler::RemoveFile("logo.pcx");
  57         wxMemoryFSHandler::RemoveFile("about.htm");
  58     }
  59     @endcode
  60
  61     @library{wxbase}
  62     @category{vfs}
  63
  64     @see wxMemoryFSHandler::AddFileWithMimeType
  65 */
  66 class wxMemoryFSHandler : public wxFileSystemHandler
  67 {
  68 public:
  69     /**
  70         Constructor.
  71     */
  72     wxMemoryFSHandler();
  73
  74     //@{
  75     /**
  76         Adds a file to the list of the files stored in memory.
  77
  78         Stored data (bitmap, text or raw data) will be copied into private memory
  79         stream and available under name @c "memory:" + @e filename.
  80
  81         @note you must use a @a type value (aka image format) that wxWidgets
  82               can save (e.g. JPG, PNG, see wxImage documentation)!
  83
  84         @see AddFileWithMimeType()
  85     */
  86     static void AddFile(const wxString& filename, wxImage& image, wxBitmapType type);
  87     static void AddFile(const wxString& filename, const wxBitmap& bitmap, wxBitmapType type);
  88     //@}
  89
  90     //@{
  91     /**
  92         Like AddFile(), but lets you explicitly specify added file's MIME type.
  93
  94         This version should be used whenever you know the MIME type, because it
  95         makes accessing the files faster.
  96
  97         @since 2.8.5
  98
  99         @see AddFile()
 100     */
 101     static void AddFileWithMimeType(const wxString& filename,
 102                                     const wxString& textdata,
 103                                     const wxString& mimetype);
 104     static void AddFileWithMimeType(const wxString& filename,
 105                                     const void* binarydata,
 106                                     size_t size,
 107                                     const wxString& mimetype);
 108     //@}
 109
 110     /**
 111         Removes a file from memory FS and frees the occupied memory.
 112     */
 113     static void RemoveFile(const wxString& filename);
 114 };
 115