add default parameters for width and style parameters of FindOrCreatePen() for consis...

[wxWidgets.git] / interface / icon.h

diff --git a/interface/icon.h b/interface/icon.h
index b7f071603db0a7218e2ddc6623bdd2828e948828..9b2d4282f21c30daa38cb9b5fa1552550743c988 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
+    ::Objects:, ::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,81 +35,111 @@ class wxIcon : public wxBitmap
 public:
     //@{
     /**
 public:
     //@{
     /**

-        Loads an icon from the specified location.
-        
+        Loads an icon from the specified location().
+

         @param bits
         @param bits

-        Specifies an array of pixel values.
-        
+            Specifies an array of pixel values.

         @param width
         @param width

-        Specifies the width of the icon.
-        
+            Specifies the width of the icon.

         @param height
         @param height

-        Specifies the height of the icon.
-        
+            Specifies the height of the icon.

         @param desiredWidth
         @param desiredWidth

-        Specifies the desired width of the icon. This
-        parameter only has an effect in Windows (32-bit) where icon resources can
+            Specifies the desired width of the icon. This
+            parameter only has an effect in Windows (32-bit) where icon resources can

         contain
         contain

-        several icons of different sizes.
-        
+            several icons of different sizes.

         @param desiredWidth
         @param desiredWidth

-        Specifies the desired height of the icon. This
-        parameter only has an effect in Windows (32-bit) where icon resources can
+            Specifies the desired height of the icon. This
+            parameter only has an effect in Windows (32-bit) where icon resources can

         contain
         contain

-        several icons of different sizes.
-        
+            several icons of different sizes.

         @param depth
         @param depth

-        Specifies the depth of the icon. If this is omitted, the display depth of the
-        screen is used.
-        
+            Specifies the depth of the icon. If this is omitted, the display depth of
+        the
+            screen is used.

         @param name
         @param name

-        This can refer to a resource name under MS Windows, or a filename under MS
+            This can refer to a resource name under MS Windows, or a filename under MS

         Windows and X.
         Windows and X.

-        Its meaning is determined by the flags parameter.
-        
+            Its meaning is determined by the flags parameter.

         @param loc
         @param loc

-        The object describing the location of the native icon, see
-        wxIconLocation.
-        
+            The object describing the location of the native icon, see
+            wxIconLocation.

         @param type
         @param type

-        May be one of the following:
-        
-        
-        wxBITMAP_TYPE_ICO
-        
-        
-        Load a Windows icon file.
-        
-        wxBITMAP_TYPE_ICO_RESOURCE
-        
-        
-        Load a Windows icon from the resource database.
-        
-        wxBITMAP_TYPE_GIF
-        
-        
-        Load a GIF bitmap file.
-        
-        wxBITMAP_TYPE_XBM
-        
-        
-        Load an X bitmap file.
-        
-        wxBITMAP_TYPE_XPM
-        
-        
-        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 ICO
-        file, ICO resource,
-        XPM data, and XPM file. Under wxGTK, the available formats are BMP file, XPM
-        data, XPM file, and PNG file.
-        Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM file.
-        
+            May be one of the following:
+
+
+
+
+
+
+
+            wxBITMAP_TYPE_ICO
+
+
+
+
+            Load a Windows icon file.
+
+
+
+
+
+            wxBITMAP_TYPE_ICO_RESOURCE
+
+
+
+
+            Load a Windows icon from the resource database.
+
+
+
+
+
+            wxBITMAP_TYPE_GIF
+
+
+
+
+            Load a GIF bitmap file.
+
+
+
+
+
+            wxBITMAP_TYPE_XBM
+
+
+
+
+            Load an X bitmap file.
+
+
+
+
+
+            wxBITMAP_TYPE_XPM
+
+
+
+
+            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
+        ICO file, ICO resource,
+            XPM data, and XPM file. Under wxGTK, the available formats are BMP 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
         @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.
+                 assignment or another member function such as Create or
+                 LoadFile must be called subsequently.

     */
     wxIcon();
     wxIcon(const wxIcon& icon);
     */
     wxIcon();
     wxIcon(const wxIcon& icon);


@@ -131,19 +159,18 @@ public:
         Destructor.
         See @ref overview_refcountdestruct "reference-counted object destruction" for
         more info.
         Destructor.
         See @ref overview_refcountdestruct "reference-counted object destruction" for
         more info.

-        

         If the application omits to delete the icon explicitly, the icon will be
         destroyed automatically by wxWidgets when the application exits.
         If the application omits to delete the icon explicitly, the icon will be
         destroyed automatically by wxWidgets when the application exits.

-        

         Do not delete an icon that is selected into a memory device context.
     */
     ~wxIcon();
 
     /**
         Do not delete an icon that is selected into a memory device context.
     */
     ~wxIcon();
 
     /**

-        Copies @e bmp bitmap to this icon. Under MS Windows the bitmap
+        Copies @a bmp bitmap to this icon. Under MS Windows the bitmap

         must have mask colour set.
         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 )


@@ -155,98 +182,147 @@ 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.

-        
-        @sa GetHeight()
+
+        @see GetHeight()

     */
     */

-    int GetWidth();
+    int GetWidth() const;

 
     /**
         Returns @true if icon data is present.
     */
 
     /**
         Returns @true if icon data is present.
     */

-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;

 
     /**
         Loads an icon from a file or resource.
 
     /**
         Loads an icon from a file or resource.

-        
+

         @param name
         @param name

-        Either a filename or a Windows resource name.
-        The meaning of name is determined by the type parameter.
-        
+            Either a filename or a Windows resource name.
+            The meaning of name is determined by the type parameter.

         @param type
         @param type

-        One of the following values:
-        
-        
-        wxBITMAP_TYPE_ICO
-        
-        
-        Load a Windows icon file.
-        
-        wxBITMAP_TYPE_ICO_RESOURCE
-        
-        
-        Load a Windows icon from the resource database.
-        
-        wxBITMAP_TYPE_GIF
-        
-        
-        Load a GIF bitmap file.
-        
-        wxBITMAP_TYPE_XBM
-        
-        
-        Load an X bitmap file.
-        
-        wxBITMAP_TYPE_XPM
-        
-        
-        Load an XPM bitmap file.
-        
-        The validity of these flags depends on the platform and wxWidgets configuration.
-        
+            One of the following values:
+
+
+
+
+
+
+
+            wxBITMAP_TYPE_ICO
+
+
+
+
+            Load a Windows icon file.
+
+
+
+
+
+            wxBITMAP_TYPE_ICO_RESOURCE
+
+
+
+
+            Load a Windows icon from the resource database.
+
+
+
+
+
+            wxBITMAP_TYPE_GIF
+
+
+
+
+            Load a GIF bitmap file.
+
+
+
+
+
+            wxBITMAP_TYPE_XBM
+
+
+
+
+            Load an X bitmap file.
+
+
+
+
+
+            wxBITMAP_TYPE_XPM
+
+
+
+
+            Load an XPM bitmap file.
+
+
+
+
+
+            The validity of these flags depends on the platform and wxWidgets
+        configuration.
+

         @returns @true if the operation succeeded, @false otherwise.
         @returns @true if the operation succeeded, @false otherwise.

-        
-        @sa wxIcon()
+
+        @see wxIcon()

     */
     bool LoadFile(const wxString& name, wxBitmapType type);
 
     /**
         Sets the depth member (does not affect the icon data).
     */
     bool LoadFile(const wxString& name, wxBitmapType type);
 
     /**
         Sets the depth member (does not affect the icon data).

-        
+

         @param depth
         @param depth

-        Icon depth.
+            Icon depth.

     */
     void SetDepth(int depth);
 
     /**
         Sets the height member (does not affect the icon data).
     */
     void SetDepth(int depth);
 
     /**
         Sets the height member (does not affect the icon data).

-        
+

         @param height
         @param height

-        Icon height in pixels.
+            Icon height in pixels.

     */
     void SetHeight(int height);
 
     /**
         Sets the width member (does not affect the icon data).
     */
     void SetHeight(int height);
 
     /**
         Sets the width member (does not affect the icon data).

-        
+

         @param width
         @param width

-        Icon width in pixels.
+            Icon width in pixels.

     */
     void SetWidth(int width);
 
     /**
         Assignment operator, using @ref overview_trefcount "reference counting".
     */
     void SetWidth(int width);
 
     /**
         Assignment operator, using @ref overview_trefcount "reference counting".

-        
+

         @param icon
         @param icon

-        Icon to assign.
+            Icon to assign.

     */
     wxIcon operator =(const wxIcon& icon);
 };
     */
     wxIcon operator =(const wxIcon& icon);
 };

+
+
+/**
+    FIXME
+*/
+wxIcon Objects:
+;
+
+/**
+    FIXME
+*/
+wxIcon wxNullIcon;
+
+