Class: Wx::DataFormat

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

Overview

A DataFormat is an encapsulation of a platform-specific format handle which is used by the system for the clipboard and drag and drop operations.

The applications are usually only interested in, for example, pasting data from the clipboard only if the data is in a format the program understands and a data format is something which uniquely identifies this format. On the system level, a data format is usually just a number (CLIPFORMAT under Windows or Atom under X11, for example) and the standard formats are, indeed, just numbers which can be implicitly converted to DataFormat. The standard formats are:

Wx::DataFormatId::DF_INVALID An invalid format - used as default argument for functions taking a DataFormat argument sometimes.

DF_TEXT Text format (String).

DF_BITMAP A bitmap (Bitmap).

Wx::DataFormatId::DF_METAFILE A metafile (Metafile, Windows only).

DF_UNICODETEXT Unicode text format (String).

DF_FILENAME A list of filenames.

Wx::DataFormatId::DF_HTML An HTML string. This is currently only valid on Mac and MSW.

Wx::DataFormatId::DF_PNG A PNG file. This is valid only on MSW. This constant is available since wxWidgets 3.1.5.

As mentioned above, these standard formats may be passed to any function taking DataFormat argument because DataFormat has an implicit conversion from them (or, to be precise from the type NativeFormat which is the type used by the underlying platform for data formats). Aside the standard formats, the application may also use custom formats which are identified by their names (strings) and not numeric identifiers. Although internally custom format must be created (or registered) first, you shouldn’t care about it because it is done automatically the first time the DataFormat object corresponding to a given format name is created. The only implication of this is that you should avoid having global DataFormat objects with non-default constructor because their constructors are executed before the program has time to perform all necessary initialisations and so an attempt to do clipboard format registration at this time will usually lead to a crash!

Category: Clipboard and Drag & Drop

See Also:

Requires:

  • USE_CLIPBOARD

Instance Method Summary collapse

Constructor Details

#initialize(format = Wx::DataFormatId::DF_INVALID) ⇒ Wx::DataFormat #initialize(format) ⇒ Wx::DataFormat

Returns a new instance of DataFormat.

Overloads:

  • #initialize(format = Wx::DataFormatId::DF_INVALID) ⇒ Wx::DataFormat

    Constructs a data format object for one of the standard data formats or an empty data object (use #set_type or #set_id later in this case).

    Parameters:

  • #initialize(format) ⇒ Wx::DataFormat

    Constructs a data format object for a custom format identified by its name format.

    Parameters:

    • format (String) 


58
 
# File 'lib/wx/doc/gen/data_format.rb', line 58

def initialize(*args) end

Instance Method Details

#==(format) ⇒ Boolean

Returns true if the formats are equal.

Parameters:

Returns:

  • (Boolean) 


85
 
# File 'lib/wx/doc/gen/data_format.rb', line 85

def ==(format) end

#get_id ⇒ String Also known as: id

Returns the name of a custom format (this function will fail for a standard format).

Returns:

  • (String) 


62
 
# File 'lib/wx/doc/gen/data_format.rb', line 62

def get_id; end

#get_type ⇒ Wx::DataFormatId Also known as: type

Returns the platform-specific number identifying the format.

Returns:



67
 
# File 'lib/wx/doc/gen/data_format.rb', line 67

def get_type; end

#set_id(format) ⇒ void Also known as: id=

This method returns an undefined value.

Sets the format to be the custom format identified by the given name.

Parameters:

  • format (String) 


73
 
# File 'lib/wx/doc/gen/data_format.rb', line 73

def set_id(format) end

#set_type(type) ⇒ void Also known as: type=

This method returns an undefined value.

Sets the format to the given value, which should be one of Wx::DF_XXX constants.

Parameters:



79
 
# File 'lib/wx/doc/gen/data_format.rb', line 79

def set_type(type) end