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


module Wx

  # This class holds a variety of information related to font dialogs.
  # === 
  # 
  # Category:  Common Dialogs, Data Structures
  # @see wxFontDialog Overview
  # @see  Wx::Font
  # @see  Wx::FontDialog 
  # 
  # 
  # 
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
  class FontData < Object
  
    # Constructor.
    # Initializes fontColour to black, showHelp to false, allowSymbols to true, enableEffects to true, minSize to 0 and maxSize to 0.
    # @return [Wx::FontData]
    def initialize; end
    
    # Enables or disables "effects" under Windows or generic only.
    # This refers to the controls for manipulating colour, strikeout and underline properties.
    # The default value is true.
    # @param enable [Boolean] 
    # @return [void]
    def enable_effects(enable) end
    
    # Under Windows, returns a flag determining whether symbol fonts can be selected.
    # Has no effect on other platforms.
    # The default value is true.
    # @return [Boolean]
    def get_allow_symbols; end
    alias_method :allow_symbols, :get_allow_symbols
    
    # Gets the font chosen by the user if the user pressed OK ({Wx::FontDialog#show_modal} returned {Wx::StandardID::ID_OK}).
    # @return [Wx::Font]
    def get_chosen_font; end
    alias_method :chosen_font, :get_chosen_font
    
    # Gets the colour associated with the font dialog.
    # The default value is black.
    # @return [Wx::Colour,String,Symbol]
    def get_colour; end
    alias_method :colour, :get_colour
    
    # Determines whether "effects" are enabled under Windows.
    # This refers to the controls for manipulating colour, strikeout and underline properties.
    # The default value is true.
    # @return [Boolean]
    def get_enable_effects; end
    
    # Returns the state of the flags restricting the selection.
    # Note that currently these flags are only effectively used in wxMSW.
    # 
    # - {Wx::FONTRESTRICT_NONE} If no restriction applies, or a combination of the following flags:
    # - {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.
    # - {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
    # 
    # The default value is {Wx::FONTRESTRICT_NONE}.
    # @return [Integer]
    def get_restrict_selection; end
    
    # Gets the font that will be initially used by the font dialog.
    # This should have previously been set by the application.
    # @return [Wx::Font]
    def get_initial_font; end
    alias_method :initial_font, :get_initial_font
    
    # Returns true if the Help button will be shown (Windows only).
    # The default value is false.
    # @return [Boolean]
    def get_show_help; end
    alias_method :show_help, :get_show_help
    
    # Restricts the selection to a subset of the available fonts.
    # Note that currently these flags are only effectively used in wxMSW and are ignored in the other ports.
    # Possible values are:
    # 
    # - {Wx::FONTRESTRICT_NONE} No restriction, show all fonts in the dialog.
    # - {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.
    # - {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
    # 
    # The default value is {Wx::FONTRESTRICT_NONE}.
    # @param flags [Integer] 
    # @return [void]
    def restrict_selection(flags) end
    
    # Under Windows, determines whether symbol fonts can be selected.
    # Has no effect on other platforms.
    # The default value is true.
    # @param allowSymbols [Boolean] 
    # @return [void]
    def set_allow_symbols(allowSymbols) end
    alias_method :allow_symbols=, :set_allow_symbols
    
    # Sets the font that will be returned to the user (for internal use only).
    # @param font [Wx::Font,Wx::FontInfo] 
    # @return [void]
    def set_chosen_font(font) end
    alias_method :chosen_font=, :set_chosen_font
    
    # Sets the colour that will be used for the font foreground colour.
    # The default colour is black.
    # @param colour [Wx::Colour,String,Symbol] 
    # @return [void]
    def set_colour(colour) end
    alias_method :colour=, :set_colour
    
    # Sets the font that will be initially used by the font dialog.
    # @param font [Wx::Font,Wx::FontInfo] 
    # @return [void]
    def set_initial_font(font) end
    alias_method :initial_font=, :set_initial_font
    
    # Sets the valid range for the font point size (Windows only).
    # The default is 0, 0 (unrestricted range).
    # @param min [Integer] 
    # @param max [Integer] 
    # @return [void]
    def set_range(min, max) end
    
    # Determines whether the Help button will be displayed in the font dialog (Windows only).
    # The default value is false.
    # @param showHelp [Boolean] 
    # @return [void]
    def set_show_help(showHelp) end
    alias_method :show_help=, :set_show_help
    
  end # FontData
  

end