Class: Wx::IconBundle
- Defined in:
- lib/wx/doc/gen/icon.rb
Overview
This class is untracked and should not be derived from nor instances extended!
This class contains multiple copies of an icon in different sizes.
It is typically used in Dialog#set_icons and TopLevelWindow#set_icons.
Category: Graphics Device Interface (GDI) Predefined objects/pointers: NULL_ICON_BUNDLE
Constant Summary collapse
- FALLBACK_NONE =
Return invalid icon if exact size is not found.
0- FALLBACK_SYSTEM =
Return the icon of the system icon size if exact size is not found.
1- FALLBACK_NEAREST_LARGER =
Return the icon of closest larger size or, if there is no icon of larger size in the bundle, the closest icon of smaller size.
2
Instance Method Summary collapse
- #add_icon(*args) ⇒ Object
- #get_icon(*args) ⇒ Object (also: #icon)
-
#get_icon_by_index(n) ⇒ Wx::Icon
(also: #icon_by_index)
return the icon at index (must be < #get_icon_count).
-
#get_icon_count ⇒ Integer
(also: #icon_count)
return the number of available icons.
-
#get_icon_of_exact_size(size) ⇒ Wx::Icon
(also: #icon_of_exact_size)
Returns the icon with exactly the given size or NULL_ICON if this size is not available.
-
#initialize(*args) ⇒ IconBundle
constructor
A new instance of IconBundle.
-
#is_empty ⇒ Boolean
(also: #empty?)
Returns true if the bundle doesn't contain any icons, false otherwise (in which case a call to #get_icon with default parameter should return a valid icon).
Methods inherited from GDIObject
Methods inherited from Object
#clone, #dup, #is_same_as, #un_share
Constructor Details
#initialize ⇒ Wx::IconBundle #initialize(file, type = Wx::BitmapType::BITMAP_TYPE_ANY) ⇒ Wx::IconBundle #initialize(stream, type = Wx::BitmapType::BITMAP_TYPE_ANY) ⇒ Wx::IconBundle #initialize(icon) ⇒ Wx::IconBundle #initialize(resourceName, module_) ⇒ Wx::IconBundle #initialize(ic) ⇒ Wx::IconBundle
Returns a new instance of IconBundle.
232 |
# File 'lib/wx/doc/gen/icon.rb', line 232 def initialize(*args) end |
Instance Method Details
#add_icon(file, type = Wx::BitmapType::BITMAP_TYPE_ANY) ⇒ void #add_icon(stream, type = Wx::BitmapType::BITMAP_TYPE_ANY) ⇒ void #add_icon(resourceName, module_) ⇒ void #add_icon(icon) ⇒ void
259 |
# File 'lib/wx/doc/gen/icon.rb', line 259 def add_icon(*args) end |
#get_icon(size, flags = Wx::IconBundle::FALLBACK_SYSTEM) ⇒ Wx::Icon #get_icon(size = Wx::DEFAULT_COORD, flags = Wx::IconBundle::FALLBACK_SYSTEM) ⇒ Wx::Icon Also known as: icon
280 |
# File 'lib/wx/doc/gen/icon.rb', line 280 def get_icon(*args) end |
#get_icon_by_index(n) ⇒ Wx::Icon Also known as: icon_by_index
return the icon at index (must be < #get_icon_count)
297 |
# File 'lib/wx/doc/gen/icon.rb', line 297 def get_icon_by_index(n) end |
#get_icon_count ⇒ Integer Also known as: icon_count
return the number of available icons
291 |
# File 'lib/wx/doc/gen/icon.rb', line 291 def get_icon_count; end |
#get_icon_of_exact_size(size) ⇒ Wx::Icon Also known as: icon_of_exact_size
Returns the icon with exactly the given size or NULL_ICON if this size is not available.
286 |
# File 'lib/wx/doc/gen/icon.rb', line 286 def get_icon_of_exact_size(size) end |
#is_empty ⇒ Boolean Also known as: empty?
Returns true if the bundle doesn't contain any icons, false otherwise (in which case a call to #get_icon with default parameter should return a valid icon).
302 |
# File 'lib/wx/doc/gen/icon.rb', line 302 def is_empty; end |