# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx::AUI # # # Todo{Wx::AUI::AuiPaneInfo} dock direction types used with {Wx::AUI::AuiManager}. # class AuiManagerDock < Wx::Enum # # AUI_DOCK_NONE = Wx::AUI::AuiManagerDock.new(0) # # AUI_DOCK_TOP = Wx::AUI::AuiManagerDock.new(1) # # AUI_DOCK_RIGHT = Wx::AUI::AuiManagerDock.new(2) # # AUI_DOCK_BOTTOM = Wx::AUI::AuiManagerDock.new(3) # # AUI_DOCK_LEFT = Wx::AUI::AuiManagerDock.new(4) # # AUI_DOCK_CENTER = Wx::AUI::AuiManagerDock.new(5) # # AUI_DOCK_CENTRE = Wx::AUI::AuiManagerDock.new(5) end # AuiManagerDock # {Wx::AUI::AuiManager} behaviour and visual effects style flags. # # # class AuiManagerOption < Wx::Enum # Allow a pane to be undocked to take the form of a {Wx::MiniFrame}. # AUI_MGR_ALLOW_FLOATING = Wx::AUI::AuiManagerOption.new(1) # Change the color of the title bar of the pane when it is activated. # AUI_MGR_ALLOW_ACTIVE_PANE = Wx::AUI::AuiManagerOption.new(2) # Make the pane transparent during its movement. # AUI_MGR_TRANSPARENT_DRAG = Wx::AUI::AuiManagerOption.new(4) # The possible location for docking is indicated by a translucent area. # AUI_MGR_TRANSPARENT_HINT = Wx::AUI::AuiManagerOption.new(8) # The possible location for docking is indicated by a gradually appearing partially transparent area. # AUI_MGR_VENETIAN_BLINDS_HINT = Wx::AUI::AuiManagerOption.new(16) # The possible location for docking is indicated by a rectangular outline. # AUI_MGR_RECTANGLE_HINT = Wx::AUI::AuiManagerOption.new(32) # The translucent area where the pane could be docked appears gradually. # AUI_MGR_HINT_FADE = Wx::AUI::AuiManagerOption.new(64) # Used in complement of {Wx::AUI::AuiManagerOption::AUI_MGR_VENETIAN_BLINDS_HINT} to show the hint immediately. # AUI_MGR_NO_VENETIAN_BLINDS_FADE = Wx::AUI::AuiManagerOption.new(128) # When a docked pane is resized, its content is refreshed in live (instead of moving the border alone and refreshing the content at the end). # AUI_MGR_LIVE_RESIZE = Wx::AUI::AuiManagerOption.new(256) # Default behaviour. # AUI_MGR_DEFAULT = Wx::AUI::AuiManagerOption.new(201) end # AuiManagerOption # # EVT_AUI_PANE_BUTTON = 10427 # # EVT_AUI_PANE_CLOSE = 10428 # # EVT_AUI_PANE_MAXIMIZE = 10429 # # EVT_AUI_PANE_RESTORE = 10430 # # EVT_AUI_PANE_ACTIVATED = 10431 # # EVT_AUI_RENDER = 10432 # # EVT_AUI_FIND_MANAGER = 10433 # {Wx::AUI::AuiPaneInfo} is part of the {Wx::AUI} class framework. # See also wxAUI Overview. # {Wx::AUI::AuiPaneInfo} specifies all the parameters for a pane. These parameters specify where the pane is on the screen, whether it is docked or floating, or hidden. In addition, these parameters specify the pane's docked position, floating position, preferred size, minimum size, caption text among many other parameters. # === # # Category: Window Docking (wxAUI) # @see Wx::AUI::AuiManager # @see Wx::AUI::AuiDockArt # # class AuiPaneInfo < ::Object # name of the pane # # # @return [String] def name; end # caption displayed on the window # # # @return [String] def caption; end # icon of the pane, may be invalid # # # @return [Wx::BitmapBundle] def icon; end # window that is in this pane # # # @return [Wx::Window] def window; end # floating frame window that holds the pane # # # @return [Wx::Frame] def frame; end # a combination of {Wx::PaneState} values # # # @return [Integer] def state; end # dock direction (top, bottom, left, right, center) # # # @return [Integer] def direction; end # layer number (0 = innermost layer) # # # @return [Integer] def layer; end # row number on the docking bar (0 = first row) # # # @return [Integer] def row; end # position inside the row (0 = first position) # # # @return [Integer] def position; end # size that the layout engine will prefer # # # @return [Wx::Size] def best_size; end # minimum size the pane window can tolerate # # # @return [Wx::Size] def min_size; end # maximum size the pane window can tolerate # # # @return [Wx::Size] def max_size; end # position while floating # # # @return [Wx::Point] def floating_position; end # size while floating # # # @return [Wx::Size] def floating_size; end # proportion while docked # # # @return [Integer] def proportion; end # proportion while docked # # # @param val [Integer] # @return [void] def proportion=(val); end # current rectangle (populated by {Wx::AUI}) # # # @return [Wx::Rect] def rect; end # @overload initialize() # @return [AuiPaneInfo] # @overload initialize(c) # Copy constructor. # @param c [Wx::AuiPaneInfo] # @return [AuiPaneInfo] def initialize(*args) end # {Wx::AUI::AuiPaneInfo#best_size} sets the ideal size for the pane. # The docking manager will attempt to use this size as much as possible when docking or floating the pane. # @param size [Array(Integer, Integer), Wx::Size] # @return [Wx::AuiPaneInfo] def set_best_size(size) end alias_method :best_size=, :set_best_size # {Wx::AUI::AuiPaneInfo#bottom} sets the pane dock position to the bottom side of the frame. # This is the same thing as calling Direction({Wx::AUI::AuiManagerDock::AUI_DOCK_BOTTOM}). # @return [Wx::AuiPaneInfo] def bottom; end # {Wx::AUI::AuiPaneInfo#bottom_dockable} indicates whether a pane can be docked at the bottom of the frame. # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_bottom_dockable(b=true) end alias_method :bottom_dockable=, :set_bottom_dockable # {Wx::AUI::AuiPaneInfo#caption} sets the caption of the pane. # @param c [String] # @return [Wx::AuiPaneInfo] def set_caption(c) end alias_method :caption=, :set_caption # CaptionVisible indicates that a pane caption should be visible. # If false, no pane caption is drawn. # @param visible [true,false] # @return [Wx::AuiPaneInfo] def set_caption_visible(visible=true) end alias_method :caption_visible=, :set_caption_visible # {Wx::AUI::AuiPaneInfo#center} sets the pane dock position to the left side of the frame. # The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout. This is the same thing as calling Direction({Wx::AUI::AuiManagerDock::AUI_DOCK_CENTRE}). # @return [Wx::AuiPaneInfo] def centre; end # @return [Wx::AuiPaneInfo] def center; end # {Wx::AUI::AuiPaneInfo#centre_pane} specifies that the pane should adopt the default center pane settings. # Centre panes usually do not have caption bars. This function provides an easy way of preparing a pane to be displayed in the center dock position. # @return [Wx::AuiPaneInfo] def centre_pane; end # @return [Wx::AuiPaneInfo] def center_pane; end # {Wx::AUI::AuiPaneInfo#close_button} indicates that a close button should be drawn for the pane. # @param visible [true,false] # @return [Wx::AuiPaneInfo] def set_close_button(visible=true) end alias_method :close_button=, :set_close_button # {Wx::AUI::AuiPaneInfo#default_pane} specifies that the pane should adopt the default pane settings. # @return [Wx::AuiPaneInfo] def default_pane; end # {Wx::AUI::AuiPaneInfo#destroy_on_close} indicates whether a pane should be destroyed when it is closed. # Normally a pane is simply hidden when the close button is clicked. Setting DestroyOnClose to true will cause the window to be destroyed when the user clicks the pane's close button. # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_destroy_on_close(b=true) end alias_method :destroy_on_close=, :set_destroy_on_close # {Wx::AUI::AuiPaneInfo#direction} determines the direction of the docked pane. # It is functionally the same as calling {Wx::AUI::AuiPaneInfo#left}, {Wx::AUI::AuiPaneInfo#right}, {Wx::AUI::AuiPaneInfo#top} or {Wx::AUI::AuiPaneInfo#bottom}, except that docking direction may be specified programmatically via the parameter. # @param direction [Integer] # @return [Wx::AuiPaneInfo] def set_direction(direction) end alias_method :direction=, :set_direction # {Wx::AUI::AuiPaneInfo#dock} indicates that a pane should be docked. # It is the opposite of {Wx::AUI::AuiPaneInfo#float}. # @return [Wx::AuiPaneInfo] def dock; end # {Wx::AUI::AuiPaneInfo#dock_fixed} causes the containing dock to have no resize sash. # This is useful for creating panes that span the entire width or height of a dock, but should not be resizable in the other direction. # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_dock_fixed(b=true) end alias_method :dock_fixed=, :set_dock_fixed # {Wx::AUI::AuiPaneInfo#dockable} specifies whether a frame can be docked or not. # It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b). # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_dockable(b=true) end alias_method :dockable=, :set_dockable # {Wx::AUI::AuiPaneInfo#fixed} forces a pane to be fixed size so that it cannot be resized. # After calling {Wx::AUI::AuiPaneInfo#fixed}, {Wx::AUI::AuiPaneInfo#is_fixed} will return true. # @return [Wx::AuiPaneInfo] def fixed; end # {Wx::AUI::AuiPaneInfo#float} indicates that a pane should be floated. # It is the opposite of {Wx::AUI::AuiPaneInfo#dock}. # @return [Wx::AuiPaneInfo] def float; end # {Wx::AUI::AuiPaneInfo#floatable} sets whether the user will be able to undock a pane and turn it into a floating window. # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_floatable(b=true) end alias_method :floatable=, :set_floatable # {Wx::AUI::AuiPaneInfo#floating_position} sets the position of the floating pane. # @param pos [Array(Integer, Integer), Wx::Point] # @return [Wx::AuiPaneInfo] def set_floating_position(pos) end alias_method :floating_position=, :set_floating_position # {Wx::AUI::AuiPaneInfo#floating_size} sets the size of the floating pane. # @param size [Array(Integer, Integer), Wx::Size] # @return [Wx::AuiPaneInfo] def set_floating_size(size) end alias_method :floating_size=, :set_floating_size # {Wx::AUI::AuiPaneInfo#gripper} indicates that a gripper should be drawn for the pane. # @param visible [true,false] # @return [Wx::AuiPaneInfo] def set_gripper(visible=true) end alias_method :gripper=, :set_gripper # {Wx::AUI::AuiPaneInfo#gripper_top} indicates that a gripper should be drawn at the top of the pane. # @param attop [true,false] # @return [Wx::AuiPaneInfo] def set_gripper_top(attop=true) end alias_method :gripper_top=, :set_gripper_top # {Wx::AUI::AuiPaneInfo#has_border} returns true if the pane displays a border. # @return [true,false] def has_border; end alias_method :has_border?, :has_border # {Wx::AUI::AuiPaneInfo#has_caption} returns true if the pane displays a caption. # @return [true,false] def has_caption; end alias_method :has_caption?, :has_caption # {Wx::AUI::AuiPaneInfo#has_close_button} returns true if the pane displays a button to close the pane. # @return [true,false] def has_close_button; end alias_method :has_close_button?, :has_close_button # {Wx::AUI::AuiPaneInfo#has_flag} returns true if the property specified by flag is active for the pane. # @param flag [Integer] # @return [true,false] def has_flag(flag) end alias_method :has_flag?, :has_flag # {Wx::AUI::AuiPaneInfo#has_gripper} returns true if the pane displays a gripper. # @return [true,false] def has_gripper; end alias_method :has_gripper?, :has_gripper # {Wx::AUI::AuiPaneInfo#has_gripper} returns true if the pane displays a gripper at the top. # @return [true,false] def has_gripper_top; end alias_method :has_gripper_top?, :has_gripper_top # {Wx::AUI::AuiPaneInfo#has_maximize_button} returns true if the pane displays a button to maximize the pane. # @return [true,false] def has_maximize_button; end alias_method :has_maximize_button?, :has_maximize_button # {Wx::AUI::AuiPaneInfo#has_minimize_button} returns true if the pane displays a button to minimize the pane. # @return [true,false] def has_minimize_button; end alias_method :has_minimize_button?, :has_minimize_button # {Wx::AUI::AuiPaneInfo#has_pin_button} returns true if the pane displays a button to float the pane. # @return [true,false] def has_pin_button; end alias_method :has_pin_button?, :has_pin_button # {Wx::AUI::AuiPaneInfo#hide} indicates that a pane should be hidden. # @return [Wx::AuiPaneInfo] def hide; end # {Wx::AUI::AuiPaneInfo#icon} sets the icon of the pane. # Notice that the height of the icon should be smaller than the value returned by {Wx::AUI::AuiDockArt#get_metric(wxAUI_DOCKART_CAPTION_SIZE)} to ensure that it appears correctly. # @param b [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] # @return [Wx::AuiPaneInfo] def set_icon(b) end alias_method :icon=, :set_icon # {Wx::AUI::AuiPaneInfo#is_bottom_dockable} returns true if the pane can be docked at the bottom of the managed frame. # # @see Wx::AUI::AuiPaneInfo#is_dockable # @return [true,false] def is_bottom_dockable; end alias_method :bottom_dockable?, :is_bottom_dockable # Returns true if the pane can be docked at any side. # # @see Wx::AUI::AuiPaneInfo#is_top_dockable # @see Wx::AUI::AuiPaneInfo#is_bottom_dockable # @see Wx::AUI::AuiPaneInfo#is_left_dockable # @see Wx::AUI::AuiPaneInfo#is_right_dockable # @return [true,false] def is_dockable; end alias_method :dockable?, :is_dockable # {Wx::AUI::AuiPaneInfo#is_docked} returns true if the pane is currently docked. # @return [true,false] def is_docked; end alias_method :docked?, :is_docked # {Wx::AUI::AuiPaneInfo#is_fixed} returns true if the pane cannot be resized. # @return [true,false] def is_fixed; end alias_method :fixed?, :is_fixed # {Wx::AUI::AuiPaneInfo#is_floatable} returns true if the pane can be undocked and displayed as a floating window. # @return [true,false] def is_floatable; end alias_method :floatable?, :is_floatable # {Wx::AUI::AuiPaneInfo#is_floating} returns true if the pane is floating. # @return [true,false] def is_floating; end alias_method :floating?, :is_floating # {Wx::AUI::AuiPaneInfo#is_left_dockable} returns true if the pane can be docked on the left of the managed frame. # # @see Wx::AUI::AuiPaneInfo#is_dockable # @return [true,false] def is_left_dockable; end alias_method :left_dockable?, :is_left_dockable # IsMoveable() returns true if the docked frame can be undocked or moved to another dock position. # @return [true,false] def is_movable; end alias_method :movable?, :is_movable # {Wx::AUI::AuiPaneInfo#is_ok} returns true if the {Wx::AUI::AuiPaneInfo} structure is valid. # A pane structure is valid if it has an associated window. # @return [true,false] def is_ok; end alias_method :ok?, :is_ok # {Wx::AUI::AuiPaneInfo#is_resizable} returns true if the pane can be resized. # @return [true,false] def is_resizable; end alias_method :resizable?, :is_resizable # {Wx::AUI::AuiPaneInfo#is_right_dockable} returns true if the pane can be docked on the right of the managed frame. # # @see Wx::AUI::AuiPaneInfo#is_dockable # @return [true,false] def is_right_dockable; end alias_method :right_dockable?, :is_right_dockable # {Wx::AUI::AuiPaneInfo#is_shown} returns true if the pane is currently shown. # @return [true,false] def is_shown; end alias_method :shown?, :is_shown # {Wx::AUI::AuiPaneInfo#is_toolbar} returns true if the pane contains a toolbar. # @return [true,false] def is_toolbar; end alias_method :toolbar?, :is_toolbar # {Wx::AUI::AuiPaneInfo#is_top_dockable} returns true if the pane can be docked at the top of the managed frame. # # @see Wx::AUI::AuiPaneInfo#is_dockable # @return [true,false] def is_top_dockable; end alias_method :top_dockable?, :is_top_dockable # {Wx::AUI::AuiPaneInfo#layer} determines the layer of the docked pane. # The dock layer is similar to an onion, the inner-most layer being layer 0. Each shell moving in the outward direction has a higher layer number. This allows for more complex docking layout formation. # @param layer [Integer] # @return [Wx::AuiPaneInfo] def set_layer(layer) end alias_method :layer=, :set_layer # {Wx::AUI::AuiPaneInfo#left} sets the pane dock position to the left side of the frame. # This is the same thing as calling Direction({Wx::AUI::AuiManagerDock::AUI_DOCK_LEFT}). # @return [Wx::AuiPaneInfo] def left; end # {Wx::AUI::AuiPaneInfo#left_dockable} indicates whether a pane can be docked on the left of the frame. # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_left_dockable(b=true) end alias_method :left_dockable=, :set_left_dockable # {Wx::AUI::AuiPaneInfo#max_size} sets the maximum size of the pane. # @param size [Array(Integer, Integer), Wx::Size] # @return [Wx::AuiPaneInfo] def set_max_size(size) end alias_method :max_size=, :set_max_size # {Wx::AUI::AuiPaneInfo#maximize_button} indicates that a maximize button should be drawn for the pane. # @param visible [true,false] # @return [Wx::AuiPaneInfo] def set_maximize_button(visible=true) end alias_method :maximize_button=, :set_maximize_button # {Wx::AUI::AuiPaneInfo#min_size} sets the minimum size of the pane. # Please note that this is only partially supported as of this writing. # @param size [Array(Integer, Integer), Wx::Size] # @return [Wx::AuiPaneInfo] def set_min_size(size) end alias_method :min_size=, :set_min_size # {Wx::AUI::AuiPaneInfo#minimize_button} indicates that a minimize button should be drawn for the pane. # @param visible [true,false] # @return [Wx::AuiPaneInfo] def set_minimize_button(visible=true) end alias_method :minimize_button=, :set_minimize_button # Movable indicates whether a frame can be moved. # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_movable(b=true) end alias_method :movable=, :set_movable # {Wx::AUI::AuiPaneInfo#name} sets the name of the pane so it can be referenced in lookup functions. # If a name is not specified by the user, a random name is assigned to the pane when it is added to the manager. # @param n [String] # @return [Wx::AuiPaneInfo] def set_name(n) end alias_method :name=, :set_name # PaneBorder indicates that a border should be drawn for the pane. # @param visible [true,false] # @return [Wx::AuiPaneInfo] def set_pane_border(visible=true) end alias_method :pane_border=, :set_pane_border # {Wx::AUI::AuiPaneInfo#pin_button} indicates that a pin button should be drawn for the pane. # @param visible [true,false] # @return [Wx::AuiPaneInfo] def set_pin_button(visible=true) end alias_method :pin_button=, :set_pin_button # {Wx::AUI::AuiPaneInfo#position} determines the position of the docked pane. # @param pos [Integer] # @return [Wx::AuiPaneInfo] def set_position(pos) end alias_method :position=, :set_position # {Wx::AUI::AuiPaneInfo#resizable} allows a pane to be resized if the parameter is true, and forces it to be a fixed size if the parameter is false. # This is simply an antonym for {Wx::AUI::AuiPaneInfo#fixed}. # @param resizable [true,false] # @return [Wx::AuiPaneInfo] def set_resizable(resizable=true) end alias_method :resizable=, :set_resizable # {Wx::AUI::AuiPaneInfo#right} sets the pane dock position to the right side of the frame. # This is the same thing as calling Direction({Wx::AUI::AuiManagerDock::AUI_DOCK_RIGHT}). # @return [Wx::AuiPaneInfo] def right; end # {Wx::AUI::AuiPaneInfo#right_dockable} indicates whether a pane can be docked on the right of the frame. # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_right_dockable(b=true) end alias_method :right_dockable=, :set_right_dockable # {Wx::AUI::AuiPaneInfo#row} determines the row of the docked pane. # @param row [Integer] # @return [Wx::AuiPaneInfo] def set_row(row) end alias_method :row=, :set_row # Write the safe parts of a PaneInfo object "source" into "this". # "Safe parts" are all non-UI elements (e.g. all layout determining parameters like the size, position etc.). "Unsafe parts" (pointers to button, frame and window) are not modified by this write operation. # This method is used when loading perspectives. # @param source [Wx::AuiPaneInfo] # @return [void] def safe_set(source) end # {Wx::AUI::AuiPaneInfo#set_flag} turns the property given by flag on or off with the option_state parameter. # @param flag [Integer] # @param option_state [true,false] # @return [Wx::AuiPaneInfo] def set_flag(flag, option_state) end # {Wx::AUI::AuiPaneInfo#show} indicates that a pane should be shown. # @param show [true,false] # @return [Wx::AuiPaneInfo] def show(show=true) end # {Wx::AUI::AuiPaneInfo#toolbar_pane} specifies that the pane should adopt the default toolbar pane settings. # @return [Wx::AuiPaneInfo] def toolbar_pane; end # {Wx::AUI::AuiPaneInfo#top} sets the pane dock position to the top of the frame. # This is the same thing as calling Direction({Wx::AUI::AuiManagerDock::AUI_DOCK_TOP}). # @return [Wx::AuiPaneInfo] def top; end # {Wx::AUI::AuiPaneInfo#top_dockable} indicates whether a pane can be docked at the top of the frame. # @param b [true,false] # @return [Wx::AuiPaneInfo] def set_top_dockable(b=true) end alias_method :top_dockable=, :set_top_dockable # {Wx::AUI::AuiPaneInfo#window} assigns the window pointer that the {Wx::AUI::AuiPaneInfo} should use. # This normally does not need to be specified, as the window pointer is automatically assigned to the {Wx::AUI::AuiPaneInfo} structure as soon as it is added to the manager. # @param w [Wx::Window] # @return [Wx::AuiPaneInfo] def set_window(w) end alias_method :window=, :set_window # @return [true,false] def is_valid; end alias_method :valid?, :is_valid end # AuiPaneInfo end