Contents

# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx

  # {Wx::IconLocation} is a tiny class describing the location of an (external, i.e.
  # not embedded into the application resources) icon. For most platforms it simply contains the file name but under some others (notably Windows) the same file may contain multiple icons and so this class also stores the index of the icon inside the file.
  # In any case, its details should be of no interest to the application code and most of them are not even documented here (on purpose) as it is only meant to be used as an opaque class: the application may get the object of this class from somewhere and the only reasonable thing to do with it later is to create a {Wx::Icon} from it.
  # === 
  # 
  # Category:  Graphics Device Interface (GDI)
  # @see Wx::Icon
  # @see  Wx::FileType::GetIcon 
  # 
  # 
  # 
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
  class IconLocation < ::Object
  
    # Returns true if the object is valid, i.e. was properly initialized, and false otherwise.
    # @return [Boolean]
    def is_ok; end
    alias_method :ok?, :is_ok
    
    # @param filename [String] 
    # @return [void]
    def set_file_name(filename) end
    alias_method :file_name=, :set_file_name
    
    # @return [Wx::String]
    def get_file_name; end
    alias_method :file_name, :get_file_name
    
  end # IconLocation
  

end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
wxruby3-0.9.1-x64-mingw-ucrt	lib/wx/doc/gen/icon_location.rb
wxruby3-0.9.0-x64-mingw-ucrt	lib/wx/doc/gen/icon_location.rb