]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/fs_mem.h
pen.h depends from brush.h in compat mode
[wxWidgets.git] / interface / fs_mem.h
index 6500ce5279425827c4c6728e1721b088d59da7d3..f58f101ee4f15d919315e62466f8e3c63f777957 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        fs_mem.h
-// Purpose:     documentation for wxMemoryFSHandler class
+// Purpose:     interface of wxMemoryFSHandler
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,60 +9,59 @@
 /**
     @class wxMemoryFSHandler
     @wxheader{fs_mem.h}
-    
-    This wxFileSystem handler can store arbitrary 
+
+    This 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:
-    
+
     @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", 
+        wxMemoryFSHandler::AddFile("about.htm",
                                    "htmlbodyAbout: "
                                    "img src=\"memory:logo.pcx\"/body/html");
-    
+
         wxDialog dlg(this, -1, wxString(_("About")));
         wxBoxSizer *topsizer;
         wxHtmlWindow *html;
         topsizer = new wxBoxSizer(wxVERTICAL);
-        html = new wxHtmlWindow(, -1, wxDefaultPosition, 
+        html = new wxHtmlWindow(, -1, wxDefaultPosition,
                                 wxSize(380, 160), wxHW_SCROLLBAR_NEVER);
         html-SetBorders(0);
         html-LoadPage("memory:about.htm");
-        html-SetSize(html-GetInternalRepresentation()-GetWidth(), 
+        html-SetSize(html-GetInternalRepresentation()-GetWidth(),
                       html-GetInternalRepresentation()-GetHeight());
         topsizer-Add(html, 1, wxALL, 10);
         topsizer-Add(new wxStaticLine(, -1), 0, wxEXPAND | wxLEFT | wxRIGHT, 10);
-        topsizer-Add(new wxButton(, wxID_OK, "Ok"), 
+        topsizer-Add(new wxButton(, wxID_OK, "Ok"),
                       0, wxALL | wxALIGN_RIGHT, 15);
         dlg.SetAutoLayout(@true);
         dlg.SetSizer(topsizer);
         topsizer-Fit();
         dlg.Centre();
         dlg.ShowModal();
-        
+
         wxMemoryFSHandler::RemoveFile("logo.pcx");
         wxMemoryFSHandler::RemoveFile("about.htm");
     }
     @endcode
-    
+
     @library{wxbase}
     @category{FIXME}
-    
-    @seealso
-    wxMemoryFSHandler::AddFileWithMimeType
+
+    @see wxMemoryFSHandler::AddFileWithMimeType
 */
 class wxMemoryFSHandler : public wxFileSystemHandler
 {
@@ -74,23 +73,22 @@ public:
 
     //@{
     /**
-        Add file to list of files stored in memory. Stored 
+        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 
+        will be copied into private memory stream and available under
         name "memory:" + @e filename.
-        
-        The @e type argument is one of @c wxBITMAP_TYPE_XXX constants.
-        Note that you must use a @e type value (aka image format)
+        The @a type argument is one of @c wxBITMAP_TYPE_XXX constants.
+        Note that you must use a @a type value (aka image format)
         that wxWidgets can save (e.g. JPG, PNG, see wxImage
-        documentation)!
+        documentation())!
         
-        @sa AddFileWithMimeType()
+        @see AddFileWithMimeType()
     */
     static void AddFile(const wxString& filename, wxImage& image,
                         long type);
-        static void AddFile(const wxString& filename,
-                            const wxBitmap& bitmap,
-                            long type);
+    static void AddFile(const wxString& filename,
+                        const wxBitmap& bitmap,
+                        long type);
     //@}
 
     //@{
@@ -99,17 +97,17 @@ public:
         specify added file's MIME type. This version should be used whenever you know
         the MIME type, because it makes accessing the files faster.
         
-        This function is new since wxWidgets version 2.8.5
+        @wxsince{2.8.5}
         
-        @sa AddFile()
+        @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);
+    static void AddFileWithMimeType(const wxString& filename,
+                                    const void* binarydata,
+                                    size_t size,
+                                    const wxString& mimetype);
     //@}
 
     /**
@@ -117,3 +115,4 @@ public:
     */
     static void RemoveFile(const wxString& filename);
 };
+