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


module Wx::AUI

  # {Wx::AUI::AuiToolBarItem} is part of the {Wx::AUI} class framework, representing a toolbar element.
  # See also {Wx::AUI::AuiToolBar} and wxAUI Overview.
  # It has a unique id (except for the separators which always have id = -1), the style (telling whether it is a normal button, separator or a control), the state (toggled or not, enabled or not) and short and long help strings. The default implementations use the short help string for the tooltip text which is popped up when the mouse pointer enters the tool and the long help string for the applications status bar (currently not implemented).
  # === 
  # 
  # Category:  Window Docking (wxAUI)
  # 
  class AuiToolBarItem < ::Object
  
    # @overload initialize()
    #   Default Constructor.
    #   @return [AuiToolBarItem]
    # @overload initialize(c)
    #   Assigns the properties of the {Wx::AUI::AuiToolBarItem} "c" to this.
    #   @param c [Wx::AuiToolBarItem] 
    #   @return [AuiToolBarItem]
    def initialize(*args) end
    
    # Assigns the properties of the {Wx::AUI::AuiToolBarItem} "c" to this.
    # @param c [Wx::AuiToolBarItem] 
    # @return [void]
    def assign(c) end
    
    # Assigns a window to the toolbar item.
    # @param w [Wx::Window] 
    # @return [void]
    def set_window(w) end
    alias_method :window=, :set_window
    
    # Returns the {Wx::Window}* associated to the toolbar item.
    # @return [Wx::Window]
    def get_window; end
    alias_method :window, :get_window
    
    # Sets the toolbar item identifier.
    # @param new_id [Integer] 
    # @return [void]
    def set_id(new_id) end
    alias_method :id=, :set_id
    
    # Returns the toolbar item identifier.
    # @return [Integer]
    def get_id; end
    alias_method :id, :get_id
    
    # Sets the {Wx::AUI::AuiToolBarItem} kind.
    # @param new_kind [Integer] 
    # @return [void]
    def set_kind(new_kind) end
    alias_method :kind=, :set_kind
    
    # Returns the toolbar item kind.
    # one of {Wx::ItemKind::ITEM_NORMAL}, {Wx::ItemKind::ITEM_CHECK} or {Wx::ItemKind::ITEM_RADIO}, {Wx::ItemKind::ITEM_SEPARATOR}, {Wx::ITEM_CONTROL}, {Wx::ITEM_SPACER}, {Wx::ITEM_LABEL},
    # @return [Integer]
    def get_kind; end
    alias_method :kind, :get_kind
    
    # Set the current state of the toolbar item.
    # @param new_state [Integer]  is an or'd combination of flags from {Wx::AUI::AuiPaneButtonState}
    # @return [void]
    def set_state(new_state) end
    alias_method :state=, :set_state
    
    # Gets the current state of the toolbar item.
    # an or'd combination of flags from {Wx::AUI::AuiPaneButtonState} representing the current state
    # @return [Integer]
    def get_state; end
    alias_method :state, :get_state
    
    # @param s [Wx::SizerItem] 
    # @return [void]
    def set_sizer_item(s) end
    alias_method :sizer_item=, :set_sizer_item
    
    # @return [Wx::SizerItem]
    def get_sizer_item; end
    alias_method :sizer_item, :get_sizer_item
    
    # @param s [String] 
    # @return [void]
    def set_label(s) end
    alias_method :label=, :set_label
    
    # @return [Wx::String]
    def get_label; end
    alias_method :label, :get_label
    
    # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
    # @return [void]
    def set_bitmap(bmp) end
    alias_method :bitmap=, :set_bitmap
    
    # @return [Wx::Bitmap]
    def get_bitmap; end
    alias_method :bitmap, :get_bitmap
    
    # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
    # @return [void]
    def set_disabled_bitmap(bmp) end
    alias_method :disabled_bitmap=, :set_disabled_bitmap
    
    # @return [Wx::Bitmap]
    def get_disabled_bitmap; end
    alias_method :disabled_bitmap, :get_disabled_bitmap
    
    # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
    # @return [void]
    def set_hover_bitmap(bmp) end
    alias_method :hover_bitmap=, :set_hover_bitmap
    
    # @return [Wx::Bitmap]
    def get_hover_bitmap; end
    alias_method :hover_bitmap, :get_hover_bitmap
    
    # @param s [String] 
    # @return [void]
    def set_short_help(s) end
    alias_method :short_help=, :set_short_help
    
    # @return [Wx::String]
    def get_short_help; end
    alias_method :short_help, :get_short_help
    
    # @param s [String] 
    # @return [void]
    def set_long_help(s) end
    alias_method :long_help=, :set_long_help
    
    # @return [Wx::String]
    def get_long_help; end
    alias_method :long_help, :get_long_help
    
    # @param s [Array(Integer, Integer), Wx::Size] 
    # @return [void]
    def set_min_size(s) end
    alias_method :min_size=, :set_min_size
    
    # @return [Wx::Size]
    def get_min_size; end
    alias_method :min_size, :get_min_size
    
    # @param s [Integer] 
    # @return [void]
    def set_spacer_pixels(s) end
    alias_method :spacer_pixels=, :set_spacer_pixels
    
    # @return [Integer]
    def get_spacer_pixels; end
    alias_method :spacer_pixels, :get_spacer_pixels
    
    # @param p [Integer] 
    # @return [void]
    def set_proportion(p) end
    alias_method :proportion=, :set_proportion
    
    # @return [Integer]
    def get_proportion; end
    alias_method :proportion, :get_proportion
    
    # @param b [true,false] 
    # @return [void]
    def set_active(b) end
    alias_method :active=, :set_active
    
    # @return [true,false]
    def is_active; end
    alias_method :active?, :is_active
    
    # Set whether this tool has a drop down button.
    # This is only valid for {Wx::ItemKind::ITEM_NORMAL} tools.
    # @param b [true,false] 
    # @return [void]
    def set_has_drop_down(b) end
    alias_method :has_drop_down=, :set_has_drop_down
    
    # Returns whether the toolbar item has an associated drop down button.
    # @return [true,false]
    def has_drop_down; end
    alias_method :has_drop_down?, :has_drop_down
    
    # @param b [true,false] 
    # @return [void]
    def set_sticky(b) end
    alias_method :sticky=, :set_sticky
    
    # @return [true,false]
    def is_sticky; end
    alias_method :sticky?, :is_sticky
    
    # @param l [Integer] 
    # @return [void]
    def set_user_data(l) end
    alias_method :user_data=, :set_user_data
    
    # @return [Integer]
    def get_user_data; end
    alias_method :user_data, :get_user_data
    
    # @param l [Integer] 
    # @return [void]
    def set_alignment(l) end
    alias_method :alignment=, :set_alignment
    
    # @return [Integer]
    def get_alignment; end
    alias_method :alignment, :get_alignment
    
    # Returns whether the toolbar item can be toggled.
    # @return [true,false]
    def can_be_toggled; end
    alias_method :can_be_toggled?, :can_be_toggled
    
  end # AuiToolBarItem
  

end