Contents

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


module Wx

  # An MDI client window is a child of {Wx::MDIParentFrame}, and manages zero or more {Wx::MDIChildFrame} objects.
  # The client window is the area where MDI child windows exist. It doesn't have to cover the whole parent frame; other windows such as toolbars and a help window might coexist with it. There can be scrollbars on a client window, which are controlled by the parent window style.
  # The {Wx::MDIClientWindow} class is usually adequate without further derivation, and it is created automatically when the MDI parent frame is created. If the application needs to derive a new class, the function {Wx::MDIParentFrame#on_create_client} must be overridden in order to give an opportunity to use a different class of client window.
  # Under wxMSW, the client window will automatically have a sunken border style when the active child is not maximized, and no border style when a child is maximized.
  # === 
  # 
  # Category:  Managed Windows
  # @see Wx::MDIChildFrame
  # @see  Wx::MDIParentFrame
  # @see  Wx::Frame 
  # 
  # 
  class MDIClientWindow < Window
  
    # Default constructor.
    # Objects of this class are only created by {Wx::MDIParentFrame} which uses the default constructor and calls {Wx::MDIClientWindow#create_client} immediately afterwards.
    # @return [Wx::MDIClientWindow]
    def initialize; end
    
    # Called by {Wx::MDIParentFrame} immediately after creating the client window.
    # This function may be overridden in the derived class but the base class version must usually be called first to really create the window.
    # @param parent [Wx::MDIParentFrame]  The window parent.
    # @param style [Integer]  The window style. Only {Wx::HSCROLL} and {Wx::VSCROLL} bits are meaningful here.
    # @return [Boolean]
    def create_client(parent, style=0) end
    
  end # MDIClientWindow
  

end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
wxruby3-0.9.1-x64-mingw-ucrt	lib/wx/doc/gen/mdi_client_window.rb
wxruby3-0.9.0-x64-mingw-ucrt	lib/wx/doc/gen/mdi_client_window.rb