Module: Wx::WithImages

Included in:
BookCtrlBase, TreeCtrl
Defined in:
lib/wx/doc/gen/with_images.rb

Overview

Note:

In wxRuby this is a mixin module instead of a (base) class.

A mixin class to be used with other classes that use a ImageList.

This class is used by classes such as Notebook and TreeCtrl, that use image indices to specify the icons used for their items (page icons for the former or the items inside the control for the latter). The icon index can either be a special value NO_IMAGE to indicate that an item doesn’t use an image at all or a small positive integer to specify the index of the icon in the list of images maintained by this class. Note that for many controls, either none of the items should have an icon or all of them should have one, i.e. mixing the items with and without an icon doesn’t always work well and may result in less than ideal appearance. To initialize the list of icons used, call #set_images method passing it a vector of BitmapBundle objects which can, in the simplest case, be just Bitmap or Icon objects however, as always with BitmapBundle, either more than one bitmap or icon needs to be specified or the bitmap bundle needs to be created from SVG to obtain better appearance in high DPI. Alternative, traditional API which was the only one available until wxWidgets 3.1.6, is based on the use of ImageList class. To use it, you need to create an object of this class and then call either assign_image_list to set this image list and give the control its ownership or #set_image_list to retain the ownership of the image list, which can be useful if the same image list is shared by multiple controls, but requires deleting the image list later.

Note:

ImageList-based API is not formally deprecated, but its use is discouraged because it is more complicated than simply providing a vector of bitmaps and it doesn't allow specifying multiple images or using SVG, which is required for good high DPI support. Please don't use assign_image_list and #set_image_list in the new code and use #set_images instead.

Instance Method Summary collapse

Instance Method Details

#get_image_count ⇒ Integer Also known as: image_count

Return the number of images in this control.

The returned value may be 0 if there are no images associated with the control.

Returns:

  • (Integer)

See Also:



34
 
# File 'lib/wx/doc/gen/with_images.rb', line 34

def get_image_count; end

#get_image_list ⇒ Wx::ImageList Also known as: image_list

Returns the associated image list, may be NULL.

Note that the new code should use #get_updated_image_list_for instead.

Returns:

See Also:



68
 
# File 'lib/wx/doc/gen/with_images.rb', line 68

def get_image_list; end

#get_updated_image_list_for(win) ⇒ Wx::ImageList Also known as: updated_image_list_for

Returns the image list updated to reflect the DPI scaling used for the given window if possible.

If #set_images has been called, this function creates the image list containing the images using the DPI scaling in effect for the provided win, which must be valid. Otherwise it behaves as #get_image_list, i.e. returns the image list previously set using #set_image_list or assign_image_list, and just returns NULL if none of them had been called. Possibly null pointer owned by this object, i.e. which must not be deleted by the caller.

Parameters:

Returns:



78
 
# File 'lib/wx/doc/gen/with_images.rb', line 78

def get_updated_image_list_for(win) end

#has_images ⇒ Boolean Also known as: has_images?

Return true if the control has any images associated with it.

Returns:

  • (Boolean)

See Also:



42
 
# File 'lib/wx/doc/gen/with_images.rb', line 42

def has_images; end

#initialize ⇒ Wx::WithImages

Returns:



27
 
# File 'lib/wx/doc/gen/with_images.rb', line 27

def initialize; end

#set_image_list(imageList) ⇒ void Also known as: image_list=

This method returns an undefined value.

Sets the image list for the page control and takes ownership of the list.

This function exists for compatibility only, please use #set_images in the new code.

Parameters:

See Also:



59
 
# File 'lib/wx/doc/gen/with_images.rb', line 59

def set_image_list(imageList) end

#set_images(images) ⇒ void

This method returns an undefined value.

Set the images to use for the items in the control.

This function allows to specify the images to use in multiple different resolutions, letting the control to select the appropriate one for its DPI scaling. For this reason, it should be preferred to using the functions taking ImageList, which has a fixed size, in the new code.

Parameters:

  • images (Array<Wx::Image>) —

    Non empty vector of bitmap bundles. Valid image indexes for the items in this control are determined by the size of this vector.



50
 
# File 'lib/wx/doc/gen/with_images.rb', line 50

def set_images(images) end