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


module Wx

  # Objects of this class are similar in appearance to the normal {Wx::Buttons} but are similar to the links in a web page in functionality.
  # Pressing such button usually results in switching to another window of the program and so they can be used as a replacement for the "Next" button in a multi-page dialog (such as {Wx::Wizard}), for example.
  # Their advantage compared to the ordinary {Wx::Buttons} is that they emphasize the action of switching the window and also that they allow to give more detailed explanation to the user because, in addition to the short button label, they also show a longer description string.
  # The short, title-like, part of the label is called the main label and the longer description is the note. Both of them can be set and queried independently using {Wx::CommandLinkButton}-specific methods such as {Wx::CommandLinkButton#set_main_label} or {Wx::CommandLinkButton#get_note} or also via {Wx::CommandLinkButton#set_label} and {Wx::CommandLinkButton#get_label} methods inherited from {Wx::Button}. When using the latter, the main label and the note are concatenated into a single string using a new line character between them (notice that the note part can have more new lines in it).
  # {Wx::CommandLinkButton} generates the same event as {Wx::Button} but doesn't support any of {Wx::Button}-specific styles nor adds any new styles of its own.
  # Currently this class uses native implementation under Windows Vista and later versions and a generic implementation for the other platforms and earlier Windows versions.
  # 
  # === 
  # 
  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
  #   </td><td> wxGTK Appearance
  #   </td><td> wxOSX Appearance
  #   </td></tr></table></div>
  # @see Wx::Button
  # @see  Wx::BitmapButton 
  # 
  # 
  class CommandLinkButton < Button
  
    # @overload initialize()
    #   Default constructor.
    #   Use {Wx::CommandLinkButton#create} to really create the control.
    #   @return [Wx::CommandLinkButton]
    # @overload initialize(parent, id, mainLabel=(''), note=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ButtonNameStr)
    #   Constructor really creating a command Link button.
    #   The button will be decorated with stock icons under GTK+ 2.
    #   @see Wx::CommandLinkButton#create
    #   @see  Wx::Validator 
    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
    #   @param id [Integer]  Button identifier. A value of {Wx::StandardID::ID_ANY} indicates a default value.
    #   @param mainLabel [String]  First line of text on the button, typically the label of an action that will be made when the button is pressed.
    #   @param note [String]  Second line of text describing the action performed when the button is pressed.
    #   @param pos [Array(Integer, Integer), Wx::Point]  Button position.
    #   @param size [Array(Integer, Integer), Wx::Size]  Button size. If the default size is specified then the button is sized appropriately for the text.
    #   @param style [Integer]  Window style. See {Wx::Button} class description.
    #   @param validator [Wx::Validator]  Window validator.
    #   @param name [String]  Window name.
    #   @return [Wx::CommandLinkButton]
    def initialize(*args) end
    
    # Button creation function for two-step creation.
    # For more details, see {Wx::CommandLinkButton#initialize}.
    # @param parent [Wx::Window] 
    # @param id [Integer] 
    # @param mainLabel [String] 
    # @param note [String] 
    # @param pos [Array(Integer, Integer), Wx::Point] 
    # @param size [Array(Integer, Integer), Wx::Size] 
    # @param style [Integer] 
    # @param validator [Wx::Validator] 
    # @param name [String] 
    # @return [Boolean]
    def create(parent, id, mainLabel=(''), note=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ButtonNameStr) end
    
    # Sets a new main label and note for the button.
    # Neither of the arguments can be empty, if you need to change just the label or just the note, use {Wx::CommandLinkButton#set_main_label} or {Wx::CommandLinkButton#set_note} instead of this function.
    # @param mainLabel [String]  New main label to use.
    # @param note [String]  New note to use.
    # @return [void]
    def set_main_label_and_note(mainLabel, note) end
    
    # Sets the string label and note for the button.
    # @param label [String]  The label and note to set, with the two separated by the first newline or none to set a blank note.
    # @return [void]
    def set_label(label) end
    alias_method :label=, :set_label
    
    # Returns the string label for the button.
    # A string with the main label and note concatenated together with a newline separating them.
    # @see Wx::CommandLinkButton#set_label
    # @return [String]
    def get_label; end
    alias_method :label, :get_label
    
    # Changes the main label.
    # @param mainLabel [String]  New main label to use.
    # @return [void]
    def set_main_label(mainLabel) end
    alias_method :main_label=, :set_main_label
    
    # Changes the note.
    # @param note [String]  New note to use.
    # @return [void]
    def set_note(note) end
    alias_method :note=, :set_note
    
    # Returns the current main label.
    # Main label currently displayed.
    # @return [String]
    def get_main_label; end
    alias_method :main_label, :get_main_label
    
    # Returns the currently used note.
    # Note currently displayed.
    # @return [String]
    def get_note; end
    alias_method :note, :get_note
    
  end # CommandLinkButton
  

end