]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/icon.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
mac paths updated
[wxWidgets.git] / interface / icon.h
diff --git a/interface/icon.h b/interface/icon.h
index 3ce78124b14ded3774fa003b8bc5613b1a5897c3..acfca502181ab2e5b7b866a0487a2365f5f914e2 100644 (file)
--- a/interface/icon.h
+++ b/interface/icon.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        icon.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        icon.h
-// Purpose:     documentation for wxIcon class
+// Purpose:     interface of wxIcon
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -25,11 +25,9 @@
     @category{gdi}
 
     @stdobjects
     @category{gdi}
 
     @stdobjects
-    Objects:
-    wxNullIcon
+    ::wxNullIcon
 
 
-    @seealso
-    @ref overview_wxbitmapoverview "Bitmap and icon overview", @ref
+    @see @ref overview_wxbitmapoverview "Bitmap and icon overview", @ref
     overview_supportedbitmapformats "supported bitmap file formats", wxDC::DrawIcon, wxCursor
 */
 class wxIcon : public wxBitmap
     overview_supportedbitmapformats "supported bitmap file formats", wxDC::DrawIcon, wxCursor
 */
 class wxIcon : public wxBitmap
@@ -37,8 +35,8 @@ class wxIcon : public wxBitmap
 public:
     //@{
     /**
 public:
     //@{
     /**
-        Loads an icon from the specified location.
-        
+        Loads an icon from the specified location().
+
         @param bits
             Specifies an array of pixel values.
         @param width
         @param bits
             Specifies an array of pixel values.
         @param width
@@ -68,68 +66,68 @@ public:
             wxIconLocation.
         @param type
             May be one of the following:
             wxIconLocation.
         @param type
             May be one of the following:
-        
-        
-        
-        
-        
-        
-        
+
+
+
+
+
+
+
             wxBITMAP_TYPE_ICO
             wxBITMAP_TYPE_ICO
-        
-        
-        
-        
+
+
+
+
             Load a Windows icon file.
             Load a Windows icon file.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxBITMAP_TYPE_ICO_RESOURCE
             wxBITMAP_TYPE_ICO_RESOURCE
-        
-        
-        
-        
+
+
+
+
             Load a Windows icon from the resource database.
             Load a Windows icon from the resource database.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxBITMAP_TYPE_GIF
             wxBITMAP_TYPE_GIF
-        
-        
-        
-        
+
+
+
+
             Load a GIF bitmap file.
             Load a GIF bitmap file.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxBITMAP_TYPE_XBM
             wxBITMAP_TYPE_XBM
-        
-        
-        
-        
+
+
+
+
             Load an X bitmap file.
             Load an X bitmap file.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxBITMAP_TYPE_XPM
             wxBITMAP_TYPE_XPM
-        
-        
-        
-        
+
+
+
+
             Load an XPM bitmap file.
             Load an XPM bitmap file.
-        
-        
-        
-        
-        
+
+
+
+
+
             The validity of these flags depends on the platform and wxWidgets
         configuration.
             If all possible wxWidgets settings are used, the Windows platform supports
             The validity of these flags depends on the platform and wxWidgets
         configuration.
             If all possible wxWidgets settings are used, the Windows platform supports
@@ -138,7 +136,7 @@ public:
         XPM data, XPM file, and PNG file.
             Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM
         file.
         XPM data, XPM file, and PNG file.
             Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM
         file.
-        
+
         @remarks The first form constructs an icon object with no data; an
                  assignment or another member function such as Create or
                  LoadFile must be called subsequently.
         @remarks The first form constructs an icon object with no data; an
                  assignment or another member function such as Create or
                  LoadFile must be called subsequently.
@@ -170,9 +168,9 @@ public:
     /**
         Copies @a bmp bitmap to this icon. Under MS Windows the bitmap
         must have mask colour set.
     /**
         Copies @a bmp bitmap to this icon. Under MS Windows the bitmap
         must have mask colour set.
-        
+
         LoadFile()
         LoadFile()
-        
+
         Wx::Icon-new( width, height, depth = -1 )
         Wx::Icon-new( name, type, desiredWidth = -1, desiredHeight = -1 )
         Wx::Icon-newFromBits( bits, width, height, depth = 1 )
         Wx::Icon-new( width, height, depth = -1 )
         Wx::Icon-new( name, type, desiredWidth = -1, desiredHeight = -1 )
         Wx::Icon-newFromBits( bits, width, height, depth = 1 )
@@ -184,107 +182,107 @@ public:
         Gets the colour depth of the icon. A value of 1 indicates a
         monochrome icon.
     */
         Gets the colour depth of the icon. A value of 1 indicates a
         monochrome icon.
     */
-    int GetDepth();
+    int GetDepth() const;
 
     /**
         Gets the height of the icon in pixels.
     */
 
     /**
         Gets the height of the icon in pixels.
     */
-    int GetHeight();
+    int GetHeight() const;
 
     /**
         Gets the width of the icon in pixels.
 
     /**
         Gets the width of the icon in pixels.
-        
+
         @see GetHeight()
     */
         @see GetHeight()
     */
-    int GetWidth();
+    int GetWidth() const;
 
     /**
         Returns @true if icon data is present.
     */
 
     /**
         Returns @true if icon data is present.
     */
-    bool IsOk();
+    bool IsOk() const;
 
     /**
         Loads an icon from a file or resource.
 
     /**
         Loads an icon from a file or resource.
-        
+
         @param name
             Either a filename or a Windows resource name.
             The meaning of name is determined by the type parameter.
         @param type
             One of the following values:
         @param name
             Either a filename or a Windows resource name.
             The meaning of name is determined by the type parameter.
         @param type
             One of the following values:
-        
-        
-        
-        
-        
-        
-        
+
+
+
+
+
+
+
             wxBITMAP_TYPE_ICO
             wxBITMAP_TYPE_ICO
-        
-        
-        
-        
+
+
+
+
             Load a Windows icon file.
             Load a Windows icon file.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxBITMAP_TYPE_ICO_RESOURCE
             wxBITMAP_TYPE_ICO_RESOURCE
-        
-        
-        
-        
+
+
+
+
             Load a Windows icon from the resource database.
             Load a Windows icon from the resource database.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxBITMAP_TYPE_GIF
             wxBITMAP_TYPE_GIF
-        
-        
-        
-        
+
+
+
+
             Load a GIF bitmap file.
             Load a GIF bitmap file.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxBITMAP_TYPE_XBM
             wxBITMAP_TYPE_XBM
-        
-        
-        
-        
+
+
+
+
             Load an X bitmap file.
             Load an X bitmap file.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxBITMAP_TYPE_XPM
             wxBITMAP_TYPE_XPM
-        
-        
-        
-        
+
+
+
+
             Load an XPM bitmap file.
             Load an XPM bitmap file.
-        
-        
-        
-        
-        
+
+
+
+
+
             The validity of these flags depends on the platform and wxWidgets
         configuration.
             The validity of these flags depends on the platform and wxWidgets
         configuration.
-        
-        @returns @true if the operation succeeded, @false otherwise.
-        
+
+        @return @true if the operation succeeded, @false otherwise.
+
         @see wxIcon()
     */
     bool LoadFile(const wxString& name, wxBitmapType type);
 
     /**
         Sets the depth member (does not affect the icon data).
         @see wxIcon()
     */
     bool LoadFile(const wxString& name, wxBitmapType type);
 
     /**
         Sets the depth member (does not affect the icon data).
-        
+
         @param depth
             Icon depth.
     */
         @param depth
             Icon depth.
     */
@@ -292,7 +290,7 @@ public:
 
     /**
         Sets the height member (does not affect the icon data).
 
     /**
         Sets the height member (does not affect the icon data).
-        
+
         @param height
             Icon height in pixels.
     */
         @param height
             Icon height in pixels.
     */
@@ -300,7 +298,7 @@ public:
 
     /**
         Sets the width member (does not affect the icon data).
 
     /**
         Sets the width member (does not affect the icon data).
-        
+
         @param width
             Icon width in pixels.
     */
         @param width
             Icon width in pixels.
     */
@@ -308,9 +306,16 @@ public:
 
     /**
         Assignment operator, using @ref overview_trefcount "reference counting".
 
     /**
         Assignment operator, using @ref overview_trefcount "reference counting".
-        
+
         @param icon
             Icon to assign.
     */
     wxIcon operator =(const wxIcon& icon);
 };
         @param icon
             Icon to assign.
     */
     wxIcon operator =(const wxIcon& icon);
 };
+
+/**
+    An empty wxIcon.
+*/
+wxIcon wxNullIcon;
+
+
wxWidgets (Impactor)