Class: Wx::IconLocation

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/icon_location.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

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 Icon from it.

Category: Graphics Device Interface (GDI)

See Also:

  • Icon
  • FileType::GetIcon

Instance Method Summary collapse

Instance Method Details

#get_file_name ⇒ Wx::String Also known as: file_name

Returns:

  • (Wx::String) 


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

def get_file_name; end

#is_ok ⇒ Boolean Also known as: ok?

Returns true if the object is valid, i.e. was properly initialized, and false otherwise.

Returns:

  • (Boolean) 


25
 
# File 'lib/wx/doc/gen/icon_location.rb', line 25

def is_ok; end

#set_file_name(filename) ⇒ void Also known as: file_name=

This method returns an undefined value.

Parameters:

  • filename (String) 


30
 
# File 'lib/wx/doc/gen/icon_location.rb', line 30

def set_file_name(filename) end