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


module Wx

  # 
  SPLASH_CENTRE_ON_PARENT = 1
  
  # 
  SPLASH_CENTRE_ON_SCREEN = 2
  
  # 
  SPLASH_NO_CENTRE = 0
  
  # 
  SPLASH_TIMEOUT = 4
  
  # 
  SPLASH_NO_TIMEOUT = 0
  
  # {Wx::SplashScreen} shows a window with a thin border, displaying a bitmap describing your application.
  # Show it in application initialisation, and then either explicitly destroy it or let it time-out.
  # Example usage:
  # 
  #   wxBitmap bitmap;
  #   if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
  #   {
  #       wxSplashScreen* splash = new wxSplashScreen(bitmap,
  #           wxSPLASH_CENTRE_ON_SCREEN|wxSPLASH_TIMEOUT,
  #           6000, NULL, -1, wxDefaultPosition, wxDefaultSize,
  #           wxBORDER_SIMPLE|wxSTAY_ON_TOP);
  #   }
  #   wxYield();
  # 
  # === 
  # 
  # Category:  Managed Windows
  # 
  class SplashScreen < Frame
  
    # Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style.
    # splashStyle is a bitlist of some of the following:
    # - {Wx::SPLASH_CENTRE_ON_PARENT}- {Wx::SPLASH_CENTRE_ON_SCREEN}- {Wx::SPLASH_NO_CENTRE}- {Wx::SPLASH_TIMEOUT}- {Wx::SPLASH_NO_TIMEOUT}
    # 
    # milliseconds is the timeout in milliseconds.
    # @param bitmap [Wx::Bitmap] 
    # @param splashStyle [Integer] 
    # @param milliseconds [Integer] 
    # @param parent [Wx::Window] 
    # @param id [Integer] 
    # @param pos [Array(Integer, Integer), Wx::Point] 
    # @param size [Array(Integer, Integer), Wx::Size] 
    # @param style [Integer] 
    # @return [SplashScreen]
    def initialize(bitmap, splashStyle, milliseconds, parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::BORDER_SIMPLE|Wx::FRAME_NO_TASKBAR|Wx::STAY_ON_TOP)) end
    
    # Returns the splash style (see {splash_screen} for details).
    # @return [Integer]
    def get_splash_style; end
    alias_method :splash_style, :get_splash_style
    
    # Returns the window used to display the bitmap.
    # @return [Wx::Window]
    def get_splash_window; end
    alias_method :splash_window, :get_splash_window
    
    # Returns the timeout in milliseconds.
    # @return [Integer]
    def get_timeout; end
    alias_method :timeout, :get_timeout
    
    # Reimplement this event handler if you want to set an application variable on window destruction, for example.
    # @param event [Wx::CloseEvent] 
    # @return [void]
    def on_close_window(event) end
    
  end # SplashScreen
  

end