fix for Borland compilation

[wxWidgets.git] / interface / wx / image.h

diff --git a/interface/wx/image.h b/interface/wx/image.h
index 06bf3ac297396213bb517558fc128162c27cacca..4358c0e4da6f3906e08838c2bd20cdcf360e26eb 100644 (file)
--- a/interface/wx/image.h
+++ b/interface/wx/image.h
@@ -6,6 +6,35 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+/**
+    Possible values for the image resolution option.
+
+    @see wxImage::GetOptionInt().
+ */
+enum wxImageResolution
+{
+    /// Resolution not specified.
+    wxIMAGE_RESOLUTION_NONE = 0,
+
+    /// Resolution specified in inches.
+    wxIMAGE_RESOLUTION_INCHES = 1,
+
+    /// Resolution specified in centimetres.
+    wxIMAGE_RESOLUTION_CM = 2
+};
+
+/**
+    Possible values for PNG image type option.
+
+    @see wxImage::GetOptionInt().
+ */
+enum wxImagePNGType
+{
+    wxPNG_TYPE_COLOUR = 0,      ///< Colour PNG image.
+    wxPNG_TYPE_GREY = 2,        ///< Greyscale PNG image converted from RGB.
+    wxPNG_TYPE_GREY_RED = 3     ///< Greyscale PNG image using red as grey.
+};
+

 /**
     @class wxImageHandler
 
 /**
     @class wxImageHandler
 


@@ -676,6 +705,8 @@ public:
 
     /**
         Gets the height of the image in pixels.
 
     /**
         Gets the height of the image in pixels.

+
+        @see GetWidth(), GetSize()

     */
     int GetHeight() const;
 
     */
     int GetHeight() const;
 


@@ -748,22 +779,30 @@ public:
     unsigned char GetMaskRed() const;
 
     /**
     unsigned char GetMaskRed() const;
 
     /**

-        Gets a user-defined option. The function is case-insensitive to @a name.
+        Gets a user-defined string-valued option.

 
 

-        For example, when saving as a JPEG file, the option @b quality is
-        used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
+        Currently the only defined string option is
+        @li wxIMAGE_OPTION_FILENAME: The name of the file from which the image
+            was loaded.

 
         @see SetOption(), GetOptionInt(), HasOption()
 
         @see SetOption(), GetOptionInt(), HasOption()

+
+        @param name
+            The name of the option, case-insensitive.
+        @return
+            The value of the option or an empty string if not found. Use
+            HasOption() if an empty string can be a valid option value.

     */
     wxString GetOption(const wxString& name) const;
 
     /**
     */
     wxString GetOption(const wxString& name) const;
 
     /**

-        Gets a user-defined option as an integer.
+        Gets a user-defined integer-valued option.
+

         The function is case-insensitive to @a name.
         If the given option is not present, the function returns 0.
         Use HasOption() is 0 is a possibly valid value for the option.
 
         The function is case-insensitive to @a name.
         If the given option is not present, the function returns 0.
         Use HasOption() is 0 is a possibly valid value for the option.
 

-        Options common to all formats:
+        Generic options:

         @li wxIMAGE_OPTION_MAX_WIDTH and wxIMAGE_OPTION_MAX_HEIGHT: If either
             of these options is specified, the loaded image will be scaled down
             (preserving its aspect ratio) so that its width is less than the
         @li wxIMAGE_OPTION_MAX_WIDTH and wxIMAGE_OPTION_MAX_HEIGHT: If either
             of these options is specified, the loaded image will be scaled down
             (preserving its aspect ratio) so that its width is less than the


@@ -777,16 +816,37 @@ public:
             handler, this is still what happens however). These options must be
             set before calling LoadFile() to have any effect.
 
             handler, this is still what happens however). These options must be
             set before calling LoadFile() to have any effect.
 

-        Options for wxPNGHandler:
-        @li wxIMAGE_OPTION_PNG_FORMAT: Format for saving a PNG file.
+        @li wxIMAGE_OPTION_QUALITY: JPEG quality used when saving. This is an
+            integer in 0..100 range with 0 meaning very poor and 100 excellent
+            (but very badly compressed). This option is currently ignored for
+            the other formats.
+
+        @li wxIMAGE_OPTION_RESOLUTIONUNIT: The value of this option determines
+            whether the resolution of the image is specified in centimetres or
+            inches, see wxImageResolution enum elements.
+
+        @li wxIMAGE_OPTION_RESOLUTION, wxIMAGE_OPTION_RESOLUTIONX and
+            wxIMAGE_OPTION_RESOLUTIONY: These options define the resolution of
+            the image in the units corresponding to wxIMAGE_OPTION_RESOLUTIONUNIT
+            options value. The first option can be set before saving the image
+            to set both horizontal and vertical resolution to the same value.
+            The X and Y options are set by the image handlers if they support
+            the image resolution (currently BMP, JPEG and TIFF handlers do) and
+            the image provides the resolution information and can be queried
+            after loading the image.
+
+        Options specific to wxPNGHandler:
+        @li wxIMAGE_OPTION_PNG_FORMAT: Format for saving a PNG file, see
+            wxImagePNGType for the supported values.

         @li wxIMAGE_OPTION_PNG_BITDEPTH: Bit depth for every channel (R/G/B/A).
 
         @li wxIMAGE_OPTION_PNG_BITDEPTH: Bit depth for every channel (R/G/B/A).
 

-        Supported values for wxIMAGE_OPTION_PNG_FORMAT:
-        @li wxPNG_TYPE_COLOUR: Stores RGB image.
-        @li wxPNG_TYPE_GREY: Stores grey image, converts from RGB.
-        @li wxPNG_TYPE_GREY_RED: Stores grey image, uses red value as grey.
-

         @see SetOption(), GetOption()
         @see SetOption(), GetOption()

+
+        @param name
+            The name of the option, case-insensitive.
+        @return
+            The value of the option or 0 if not found. Use HasOption() if 0
+            can be a valid option value.

     */
     int GetOptionInt(const wxString& name) const;
 
     */
     int GetOptionInt(const wxString& name) const;
 


@@ -818,6 +878,15 @@ public:
     */
     wxImage GetSubImage(const wxRect& rect) const;
 
     */
     wxImage GetSubImage(const wxRect& rect) const;
 

+    /**
+        Returns the size of the image in pixels.
+
+        @since 2.9.0
+
+        @see GetHeight(), GetWidth()
+    */
+    wxSize GetSize() const;
+

     /**
         Gets the type of image found by LoadFile() or specified with SaveFile().
 
     /**
         Gets the type of image found by LoadFile() or specified with SaveFile().
 


@@ -828,7 +897,7 @@ public:
     /**
         Gets the width of the image in pixels.
 
     /**
         Gets the width of the image in pixels.
 

-        @see GetHeight()
+        @see GetHeight(), GetSize()

     */
     int GetWidth() const;
 
     */
     int GetWidth() const;