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


module Wx

  # {Wx::Simplebook} is a control showing exactly one of its several pages.
  # It implements {Wx::BookCtrlBase} class interface but doesn't allow the user to change the page being displayed, unlike all the other book control classes, only the program can do it.
  # This class is created in the same manner as any other {Wx::BookCtrl} but then the program will typically call {Wx::Simplebook#change_selection} to show different pages. See the Notebook Sample for an example of {Wx::Simplebook} in action.
  # Notice that it is often convenient to use {Wx::Simplebook#show_new_page} instead of the base class {Wx::Simplebook#add_page}.
  # There are no special styles defined for this class as it has no visual appearance of its own.
  # There are also no special events, this class reuses {Wx::EVT_BOOKCTRL_PAGE_CHANGING} and {Wx::EVT_BOOKCTRL_PAGE_CHANGED} events for the events it generates if the program calls {Wx::Simplebook#set_selection}.
  # === 
  # 
  # Category:  Book Controls
  # @see Wx::BookCtrl
  # @see  Wx::Notebook
  # @see  Notebook Sample
  # 
  # 
  class Simplebook < BookCtrlBase
  
    # @overload initialize()
    #   Default constructor.
    #   Use {Wx::Simplebook#create} later to really create the control.
    #   @return [Simplebook]
    # @overload initialize(parent, id=Wx::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::EMPTY_STRING)
    #   Constructs a simple book control.
    #   @param parent [Wx::Window] 
    #   @param id [Integer] 
    #   @param pos [Array(Integer, Integer), Wx::Point] 
    #   @param size [Array(Integer, Integer), Wx::Size] 
    #   @param style [Integer] 
    #   @param name [String] 
    #   @return [Simplebook]
    def initialize(*args) end
    
    # Really create the window of an object created using default constructor.
    # @param parent [Wx::Window] 
    # @param id [Integer] 
    # @param pos [Array(Integer, Integer), Wx::Point] 
    # @param size [Array(Integer, Integer), Wx::Size] 
    # @param style [Integer] 
    # @param name [String] 
    # @return [true,false]
    def create(parent, id=Wx::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::EMPTY_STRING) end
    
    # Set the effects to use for showing and hiding the pages.
    # This method allows specifying the effects passed to {Wx::Window#show_with_effect} and {Wx::Window#hide_with_effect} respectively when the pages need to be shown or hidden.
    # By default, no effects are used, but as the pages are only changed by the program and not the user himself, it may be useful to use some visual effects to make the changes more noticeable.
    # @see Wx::Simplebook#set_effects_timeouts 
    # @param showEffect [ShowEffect]  The effect to use for showing the newly selected page.
    # @param hideEffect [ShowEffect]  The effect to use for hiding the previously selected page.
    # @return [void]
    def set_effects(showEffect, hideEffect) end
    
    # Set the same effect to use for both showing and hiding the pages.
    # This is the same as <code>SetEffects(effect, effect)</code>.
    # @see Wx::Simplebook#set_effect_timeout 
    # @param effect [ShowEffect] 
    # @return [void]
    def set_effect(effect) end
    alias_method :effect=, :set_effect
    
    # Set the effect timeout to use for showing and hiding the pages.
    # This method allows configuring the timeout arguments passed to {Wx::Window#show_with_effect} and {Wx::Window#hide_with_effect} if a non-default effect is used.
    # If this method is not called, default, system-dependent timeout is used.
    # @see Wx::Simplebook#set_effects 
    # @param showTimeout [unsigned]  Timeout of the show effect, in milliseconds.
    # @param hideTimeout [unsigned]  Timeout of the hide effect, in milliseconds.
    # @return [void]
    def set_effects_timeouts(showTimeout, hideTimeout) end
    
    # Set the same effect timeout to use for both showing and hiding the pages.
    # This is the same as <code>SetEffectsTimeouts(timeout, timeout)</code>.
    # @see Wx::Simplebook#set_effect 
    # @param timeout [unsigned] 
    # @return [void]
    def set_effect_timeout(timeout) end
    alias_method :effect_timeout=, :set_effect_timeout
    
    # Add a new page and show it immediately.
    # This is simply a thin wrapper around the base class {Wx::BookCtrlBase#add_page} method using empty label (which is unused by this class anyhow) and selecting the new page immediately.
    # @param page [Wx::Window] 
    # @return [true,false]
    def show_new_page(page) end
    
  end # Simplebook
  

end