Codebase list ruby-fxruby / run/8a909198-7fff-4596-a78d-571f487fdb51/upstream rdoc-sources / FXSplashWindow.rb
run/8a909198-7fff-4596-a78d-571f487fdb51/upstream

Tree @run/8a909198-7fff-4596-a78d-571f487fdb51/upstream (Download .tar.gz)

FXSplashWindow.rb @run/8a909198-7fff-4596-a78d-571f487fdb51/upstreamraw · history · blame

module Fox
  #
  # The Splash Window is a window typically shown during startup
  # of an application.  It comprises a large icon, which is also
  # used as the shape of the window if +SPLASH_SHAPED+ is passed;
  # with the +SPLASH_SIMPLE+ option the window will be simply rectangular.
  #
  # === Splash window options
  #
  # +SPLASH_SIMPLE+::  Simple rectangular splash window
  # +SPLASH_SHAPED+::  Shaped splash window
  # +SPLASH_OWNS_ICON+:: Does nothing - for backward compatibility only
  # +SPLASH_DESTROY+::  Splash window will destroy itself when timer expires
  #
  class FXSplashWindow < FXTopWindow
    # The splash window's icon {FXIcon}
    attr_accessor :icon

    # The delay before hiding the splash window, in milliseconds [Integer]
    attr_accessor :delay

    # Construct splash window
    def initialize(owner, icon, opts=SPLASH_SIMPLE, ms=5000) # :yields: theSplashWindow
    end
  end
end