Sha256: cdec806a5a9a59f142248ebdc9f68e441ba8198e0a969305c4648aab4dab8808

Contents?: true

Size: 1.22 KB

Versions: 8

Compression:

Stored size: 1.22 KB

Contents

# :stopdoc:
# Copyright (c) 2023 M.J.N. Corino, The Netherlands
#
# This software is released under the MIT license.
# :startdoc:


class Wx

  # @!group Art creation methods

  # Searches for an art file with basename 'name' and creates an Icon if found.
  # Raises an ArgumentError if not found.
  # Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to
  # determine the values for the 'art_path' and 'art_section' arguments if not specified here
  # ('art_path' is set to the absolute path to the folder holding the caller's code and 'art_section'
  # to the basename of the caller's source file). The 'art_type' argument is set to <code>:icon</code>.
  # @param [String,Symbol] name base name of art file
  # @param [Wx::BitmapType,nil] bmp_type bitmap type for art file (nil means any supported type)
  # @param [Integer] desired_width
  # @param [Integer] desired_height
  # @param [String,nil] art_path base path to look up the art file
  # @param [String,nil] art_section optional owner folder name for art files
  # @return [Wx::Icon]
  # @see Wx::ArtLocator::find_art
  def self.Icon(name, bmp_type = nil, desired_width=-1, desired_height=-1, art_path: nil, art_section: nil); end

  # @!endgroup

end

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
wxruby3-1.3.1 lib/wx/doc/icon.rb
wxruby3-1.3.0 lib/wx/doc/icon.rb
wxruby3-1.2.1 lib/wx/doc/icon.rb
wxruby3-1.2.0 lib/wx/doc/icon.rb
wxruby3-1.1.2 lib/wx/doc/icon.rb
wxruby3-1.1.1 lib/wx/doc/icon.rb
wxruby3-1.1.0 lib/wx/doc/icon.rb
wxruby3-1.0.1 lib/wx/doc/icon.rb