Class: Wx::BusyInfoFlags

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

Overview

Note:

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

Parameters for BusyInfo.

This class exists only in order to make passing attributes to BusyInfo constructor easier and the code doing it more readable. All methods of this class return the reference to the object on which they are called, making it possible to chain them together, e.g. typically you would just create a temporary BusyInfoFlags object and then call the methods corresponding to the attributes you want to set, before finally passing the result to BusyInfo constructor, e.g.:

Wx::BusyInfo.busy(
    Wx::BusyInfoFlags.new
      .parent(self)
      .icon(Wx::ArtProvider.get_icon(Wx::ART_PRINT,Wx::ART_OTHER, [128, 128]))
      .title("<b>Printing your document</b>")
      .text("Please wait...")
      .foreground(Wx::WHITE)
      .background(Wx::BLACK)
      .transparency(4*Wx::ALPHA_OPAQUE/5)) do |bi|
  end

Requires:

  • USE_BUSYINFO

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::BusyInfoFlags

Default constructor initializes all attributes to default values.

Call the other methods to really fill in the object.



101
 
# File 'lib/wx/doc/gen/busy_info.rb', line 101

def initialize; end

Instance Method Details

#background(background) ⇒ Wx::BusyInfoFlags

Sets the background colour of Wx::BusyInfo window.

Parameters:

Returns:



142
 
# File 'lib/wx/doc/gen/busy_info.rb', line 142

def background(background) end

#foreground(foreground) ⇒ Wx::BusyInfoFlags

Sets the foreground colour of the title and text strings.

Parameters:

Returns:



137
 
# File 'lib/wx/doc/gen/busy_info.rb', line 137

def foreground(foreground) end

#icon(icon) ⇒ Wx::BusyInfoFlags

Sets the icon to show in Wx::BusyInfo.

Parameters:

Returns:



111
 
# File 'lib/wx/doc/gen/busy_info.rb', line 111

def icon(icon) end

#label(label) ⇒ Wx::BusyInfoFlags

Same as #text but doesn’t interpret the string as containing markup.

This method should be used if the text shown in Wx::BusyInfo comes from external source and so may contain characters having special meaning in simple markup, e.g. ‘<’.

Parameters:

  • label (String)

Returns:



132
 
# File 'lib/wx/doc/gen/busy_info.rb', line 132

def label(label) end

#parent(parent) ⇒ Wx::BusyInfoFlags

Sets the parent for Wx::BusyInfo.

Parameters:

Returns:



106
 
# File 'lib/wx/doc/gen/busy_info.rb', line 106

def parent(parent) end

#text(text) ⇒ Wx::BusyInfoFlags

Sets the more detailed text, shown under the title, if any.

The text string may contain markup as described in Control#set_label_markup.

Parameters:

  • text (String)

Returns:



125
 
# File 'lib/wx/doc/gen/busy_info.rb', line 125

def text(text) end

#title(title) ⇒ Wx::BusyInfoFlags

Sets the title, shown prominently in Wx::BusyInfo window.

The title string may contain markup as described in Control#set_label_markup.

Parameters:

  • title (String)

Returns:



118
 
# File 'lib/wx/doc/gen/busy_info.rb', line 118

def title(title) end

#transparency(alpha) ⇒ Wx::BusyInfoFlags

Sets the transparency of Wx::BusyInfo window.

Parameters:

Returns:

See Also:



150
 
# File 'lib/wx/doc/gen/busy_info.rb', line 150

def transparency(alpha) end