ResourceImage Class

Sets the .SystemErrorCode variable.

Raises syntax errors when incorrect arguments are detected.

The arguments are:

Returns a new ResourceImage object. This object may be null if an error occurred. Use the isNull() method to check for this. Both the .SystemErrorCode or the systemErrorCode() method should contain an error code if the object is null.

This example instantiates a resource image using the oodialog.dll module and uses it to load the generally available icon resources from that module. The icons are then displayed in a list-view control.

      
      ::method initDialog
        expose list

        list  = self~getListControl(IDC_LV_IMAGES)

        ids = .array~new()
        ids[1] = self~constDir[IDI_DLG_OODIALOG]
        ids[2] = self~constDir[IDI_DLG_APPICON]
        ids[3] = self~constDir[IDI_DLG_APPICON2]
        ids[4] = self~constDir[IDI_DLG_OOREXX]

        SM_CXICON = 11
        SM_CYICON = 12

        size = .Size~new(.DlgUtil~getSystemMetrics(SM_CXICON), .DlgUtil~getSystemMetrics(SM_CYICON))

        oodModule = .ResourceImage~new("oodialog.dll", self)
        icons = oodModule~getImages(ids, .Image~toID(IMAGE_ICON), size)

        flags = .DlgUtil~or(.Image~toID(ILC_COLOR24), .Image~toID(ILC_MASK))
        imageList = .ImageList~create(size, flags, 4, 0)
        imageList~addImages(icons)

        list~setImageList(imageList, .Image~toID(LVSIL_NORMAL))

        names = .array~new()
        names[1] = "IDI_DLG_OODIALOG"
        names[2] = "IDI_DLG_APPICON"
        names[3] = "IDI_DLG_APPICON2"
        names[4] = "IDI_DLG_OOREXX"

        do i = 1 to ids~items
          list~add(names[i] '('ids[i]')', i - 1)
        end

      
      

Raises a syntax error if the resource image is null.

Sets the .SystemErrorCode variable.

Raises syntax errors when incorrect arguments are detected.

Provides an interface to the Win32 API: LoadImage(). Use the MSDN library documentation to get more information on the arguments to this method.

The arguments are:

This method returns an .Image object that represents the specified image resource in the module. The image may be null if an error occurred, for instance if no image resource was found.

This example uses a ResDialog with a static control that displays a bitmap image. The image for the static control is obtained from the resource-only DLL used by the ResDialog.

      
      ::class SimpleDialog subclass ResDialog inherit AdvancedControls MessageExtensions
      ...

      ::method initDialog
        ...
        resources = .ResourceImage~new("simpleImage.dll", self)
        image = resources~getImage(self~constDir[ID_BMP_IMAGE1])
        ...
        picture = self~getStaticControl(IDC_BMP_PICTURE)
        oldImage = picture~setImage(image)
      
      

Raises a syntax error if the resource image is null.

Sets the .SystemErrorCode variable.

Raises syntax errors when incorrect arguments are detected.

Provides an interface to the Win32 API: LoadImage(). You can use the MSDN library documentation to get more information on the interaction between the flags, size, and type arguments.

The arguments are:

The return will be an array of .Image objects, one for each resource ID specified in the ids array, if there is no error. If there is an error loading the image of any specified ID, the corresponding index in the returned array will be empty.

If there is an error, both the .SystemErrorCode and the systemErrorCode attribute of this resource image will be set (to the same code.) It is conceivable that an error could occur where the system does not set an error code, but unlikely.

The following is a complete working dialog. Four bitmap images are used. Each time the user clicks the next button, the next image is displayed.

An array is constructed containing the resource IDs of the 4 images. A new resource image object is instantiated from the images.dll module. The getImages() method is then used to get an array of 4 .Image objects, using the array of resource IDs.

      
      /* Simple Dialog to display some images */

        dlg = .SimpleDialog~new( , 'simpleImage.h')
        if dlg~initCode = 0 then do
          dlg~createCenter(200, 247, "Simple Image Viewer", "", , "MS Shell Dlg 2", 8)
          dlg~Execute("SHOWTOP", 14)
        end

        dlg~Deinstall

      return 0
      -- End of entry point.

      ::requires "oodWin32.cls"

      ::class SimpleDialog subclass UserDialog inherit AdvancedControls MessageExtensions

      ::method defineDialog

        self~addStatic(IDC_BMP_PICTURE, 10, 10, 20, 17, "BITMAP REALSIZEIMAGE")
        self~addStatic(IDC_ST_DESCRIPTION, 14, 190, 176, 20, "TEXT LEFT", "Description")
        self~addButton(IDC_PB_NEXT, 10, 223, 50, 14, "Next", onNext)
        self~addButton(IDOK, 140, 223, 50, 14, "Ok", ok, "DEFAULT")

      ::method initDialog
        expose picture images description descriptions nextImage

        ids = .array~new
        ids[ 1] = self~constDir[ID_BMP_IMAGE1]
        ids[ 2] = self~constDir[ID_BMP_IMAGE2]
        ids[ 3] = self~constDir[ID_BMP_IMAGE3]
        ids[ 4] = self~constDir[ID_BMP_IMAGE4]

        descriptions = .array~new
        descriptions[1] = "Conrad, King of the Hill"
        descriptions[2] = "Berk, Squint Eye"
        descriptions[3] = "Cienna, Deer in the Headlights"
        descriptions[4] = "Vail, The Flower Child"

        picture = self~getStaticControl(IDC_BMP_PICTURE)
        description = self~getStaticControl(IDC_ST_DESCRIPTION)
        self~connectButton(IDC_PB_NEXT, onNext)

        nextImage = 1
        module = .ResourceImage~new("images.dll")
        images = module~getImages(ids)

        self~onNext

      ::method onNext
        expose picture description images descriptions nextImage

        if nextImage > images~items then nextImage = 1

        picture~setImage(images[nextImage])

        description~setText(descriptions[nextImage])
        nextImage += 1
      
      

Raises a syntax error if the resource image is null.

Sets the .SystemErrorCode variable.

There are no arguments.

This method return the system error code, which will be zero if there is no error, and non-zero if there is an error. The .SystemErrorCode is also set to this value.

In this example, the images for an image list are loaded from a resource module. The resource module is no longer needed after the image list is created. Since an image list makes a copy of the images added to it, once the image list has all the images added to it, the resource image can be released.

      
      ::method getImages private
        use strict arg resourceIDs, size, ilFlags

        imageList = .ImageList~create(size, ilFlags, 20, 10);

        module = .ResourceImage~new("zooImages.dll")
        images = module~getImages(resourceIDs)
        imageList~addImages(images)

        do i = 1 to images~items
          images[i]~release
        end
        module~release

        return imageList
      
      

There are no arguments.

The return is the handle for the module the resource image represents.

This example ...

      
      ::method showHandles

        oodMod = .ResourceImage~new("oodialog.dll", self)
        resMod = .ResourceImage~new("simpleImage.dll", self)

        say 'The oodialog.dll module handle is:        ' oodMod~handle
        say 'The resource module for this ResDialog is:' resMod~handle


      /* The output, for a ResDialog, might be:

         The oodialog.dll module handle is:         0x009E0000
         The resource module for this ResDialog is: 0x00AF0000
      */
      
      

There are no arguments.

Returns .true if the object is null, otherwise .false.

It is a good idea to check that a new resource image object is valid before using it.

      
      ::method initDialog
        ...
        resourceModule = .ResourceImage~new("simpleImage.dll", self)
        if \ resourceModule~isNull the do
          image = resources~getImage(self~constDir[ID_BMP_IMAGE1])
        else do
          -- Some error handling here.
        end
      
      

This method does not take any arguments.

The return is a system error code, which will usually be 0, no error.

This example uses the systemErrorCode attribute to get more information on a possbile error, rather than the .SystemErrorCode.

      
      ::method initDialog
        ...
        mod = .ResourceImage~new("simpleImage.dll", self)
        if mod~isNull the do
          self~writeToLog("Error with resource module simpleImage.dll")
          self~writeToLog("  RC: " mod~systemErrorCode)
          self~writeToLog("  msg:" SysGetErrorText(mod~systemErrorCode)
          return
        end

        image = resources~getImage(self~constDir[ID_BMP_IMAGE1])
        ...