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


module Wx

  # This class represents a dialog that shows a list of strings, and allows the user to select one or more.
  # === Styles
  # 
  # This class supports the following styles:
  #  
  # - {Wx::OK}: Show an OK button. 
  # - {Wx::CANCEL}: Show a Cancel button. 
  # - {Wx::GeometryCentre::CENTRE}: Centre the message. 
  # 
  # === 
  # 
  # Category:  Common Dialogs
  # @see wxMultiChoiceDialog Overview
  # @see  Wx::SingleChoiceDialog 
  # 
  # 
  class MultiChoiceDialog < Dialog
  
    # Constructor taking an array of {Wx::String} choices.
    # Use {Wx::MultiChoiceDialog#show_modal} to show the dialog.
    # 
    # <b>{Wx::Perl} Note:</b> Use an array reference for the choices parameter.
    # @param parent [Wx::Window]  Parent window.
    # @param message [String]  Message to show on the dialog.
    # @param caption [String]  The dialog caption.
    # @param choices [Array<String>]  An array of strings, or a string list, containing the choices.
    # @param style [Integer]  A dialog style (bitlist) containing flags chosen from standard dialog styles and the ones listed in the class documentation. The default value is equivalent to {Wx::DEFAULT_DIALOG_STYLE} | {Wx::RESIZE_BORDER} | {Wx::OK} | {Wx::CANCEL} | {Wx::GeometryCentre::CENTRE}.
    # @param pos [Array(Integer, Integer), Wx::Point]  Dialog position.
    # @return [MultiChoiceDialog]
    def initialize(parent, message, caption, choices, style=Wx::CHOICEDLG_STYLE, pos=Wx::DEFAULT_POSITION) end
    
    # Returns array with indexes of selected items.
    # @return [Array<Integer>]
    def get_selections; end
    alias_method :selections, :get_selections
    
    # Sets selected items from the array of selected items' indexes.
    # @param selections [Array<Integer>] 
    # @return [void]
    def set_selections(selections) end
    alias_method :selections=, :set_selections
    
    # Shows the dialog, returning either {Wx::StandardID::ID_OK} or {Wx::StandardID::ID_CANCEL}.
    # @return [Integer]
    def show_modal; end
    
  end # MultiChoiceDialog
  

end