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


module Wx

  # 
  CHB_DEFAULT = 0
  
  # 
  CHB_TOP = 16
  
  # 
  CHB_BOTTOM = 32
  
  # 
  CHB_LEFT = 64
  
  # 
  CHB_RIGHT = 128
  
  # 
  CHB_ALIGN_MASK = 240
  
  # 
  # 
  EVT_CHOICEBOOK_PAGE_CHANGED = 10103
  
  # 
  # 
  EVT_CHOICEBOOK_PAGE_CHANGING = 10102
  
  # {Wx::Choicebook} is a class similar to {Wx::Notebook}, but uses a {Wx::Choice} control to show the labels instead of the tabs.
  # For usage documentation of this class, please refer to the base abstract class {Wx::BookCtrl}. You can also use the Notebook Sample to see {Wx::Choicebook} in action.
  # {Wx::Choicebook} allows the use of {Wx::BookCtrlBase#get_control_sizer}, allowing a program to add other controls next to the choice control. This is particularly useful when screen space is restricted, as it often is when {Wx::Choicebook} is being employed.
  # === Styles
  # 
  # This class supports the following styles:
  #  
  # - {Wx::CHB_DEFAULT}: Choose the default location for the labels depending on the current platform (but currently it's the same everywhere, namely {Wx::CHB_TOP}). 
  # - {Wx::CHB_TOP}: Place labels above the page area. 
  # - {Wx::CHB_LEFT}: Place labels on the left side. 
  # - {Wx::CHB_RIGHT}: Place labels on the right side. 
  # - {Wx::CHB_BOTTOM}: Place labels below the page area. 
  # 
  # === Events emitted by this class
  # 
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
  # Event handler methods for events emitted by this class:
  # - {Wx::EvtHandler#evt_choicebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_CHOICEBOOK_PAGE_CHANGED} event. 
  # - {Wx::EvtHandler#evt_choicebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_CHOICEBOOK_PAGE_CHANGING} event. This event can be vetoed (using {Wx::NotifyEvent#veto}). 
  # 
  # === 
  # 
  # Category:  Book Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
  #   </td><td> {Wx::GTK} Appearance
  #   </td><td> {Wx::OSX} Appearance
  #   </td></tr></table></div>
  # @see wxBookCtrl Overview
  # @see  Wx::Notebook
  # @see  Notebook Sample 
  # 
  # 
  class Choicebook < BookCtrlBase
  
    # @overload initialize()
    #   Constructs a choicebook control.
    #   @return [Choicebook]
    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::EMPTY_STRING)
    #   Constructs a choicebook 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 [Choicebook]
    def initialize(*args) end
    
    # Create the choicebook control that has already been constructed with the 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, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::EMPTY_STRING) end
    
    # Returns the {Wx::Choice} associated with the control.
    # @return [Wx::Choice]
    def get_choice_ctrl; end
    alias_method :choice_ctrl, :get_choice_ctrl
    
  end # Choicebook
  

end