wxruby3 1.6.0 → 1.7.0

data/lib/wx/doc/gen/log.rb

@@ -0,0 +1,603 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Different standard log levels (you may also define your own) used with by standard {Wx::Log} functions {log_generic}, {log_error}, {log_warning}, etc...
+  # 
+  # 
+  # 
+  # @wxrb_require USE_LOG
+  class LogLevelValues < Wx::Enum
+  
+    # program can't continue, abort immediately
+    # 
+    LOG_FatalError = Wx::LogLevelValues.new(0)
+    
+    # a serious error, user must be informed about it
+    # 
+    LOG_Error = Wx::LogLevelValues.new(1)
+    
+    # user is normally informed about it but may be ignored
+    # 
+    LOG_Warning = Wx::LogLevelValues.new(2)
+    
+    # normal message (i.e. normal output of a non GUI app)
+    # 
+    LOG_Message = Wx::LogLevelValues.new(3)
+    
+    # informational: might go to the status line of GUI app
+    # 
+    LOG_Status = Wx::LogLevelValues.new(4)
+    
+    # informational message (a.k.a. 'Verbose')
+    # 
+    LOG_Info = Wx::LogLevelValues.new(5)
+    
+    # never shown to the user, disabled in release mode
+    # 
+    LOG_Debug = Wx::LogLevelValues.new(6)
+    
+    # trace messages are also only enabled in debug mode
+    # 
+    LOG_Trace = Wx::LogLevelValues.new(7)
+    
+    # used for progress indicator (not yet)
+    # 
+    LOG_Progress = Wx::LogLevelValues.new(8)
+    
+    # user defined levels start here
+    # 
+    LOG_User = Wx::LogLevelValues.new(100)
+    
+    # 
+    # 
+    LOG_Max = Wx::LogLevelValues.new(10000)
+    
+  end # LogLevelValues
+  
+  # {Wx::Log} class defines the interface for the log targets used by wxWidgets logging functions as explained in the Logging Overview.
+  # 
+  # The only situations when you need to directly use this class is when you want to derive your own log target because the existing ones don't satisfy your needs.
+  # Otherwise, it is completely hidden behind the wxLogXXX() functions and you may not even know about its existence.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>For console-mode applications, the default target is {Wx::LogStderr}, so that all {log_xxx} functions print on stderr when {Wx::Setup::USE_GUI} = 0.
+  # </p>
+  # </div>
+  # 
+  # Category:  {Wx::Logging}
+  # @see Logging Overview
+  # @see  wxLogXXX() functions 
+  # 
+  # 
+  # @wxrb_require USE_LOG
+  class Log < ::Object
+  
+    # Add the mask to the list of allowed masks for {log_trace}.
+    # 
+    # 
+    # @see Wx::Log.remove_trace_mask
+    # @see  Wx::Log.get_trace_masks 
+    # @param mask [String] 
+    # @return [void]
+    def self.add_trace_mask(mask) end
+    
+    # Removes all trace masks previously set with {Wx::Log.add_trace_mask}.
+    # 
+    # 
+    # @see Wx::Log.remove_trace_mask 
+    # @return [void]
+    def self.clear_trace_masks; end
+    
+    # Returns the currently allowed list of string trace masks.
+    # 
+    # 
+    # @see Wx::Log.add_trace_mask. 
+    # @return [Wx::ArrayString]
+    def self.get_trace_masks; end
+    
+    # Returns true if the mask is one of allowed masks for {log_trace}.
+    # 
+    # See also: {Wx::Log.add_trace_mask}, {Wx::Log.remove_trace_mask}
+    # @param mask [String] 
+    # @return [Boolean]
+    def self.is_allowed_trace_mask(mask) end
+    
+    # Remove the mask from the list of allowed masks for {log_trace}.
+    # 
+    # 
+    # @see Wx::Log.add_trace_mask 
+    # @param mask [String] 
+    # @return [void]
+    def self.remove_trace_mask(mask) end
+    
+    # Instructs {Wx::Log} to not create new log targets on the fly if there is none currently (see {Wx::Log.get_active_target}).
+    # 
+    # (Almost) for internal use only: it is supposed to be called by the application shutdown code (where you don't want the log target to be automatically created anymore).
+    # Note that this function also calls {Wx::Log.clear_trace_masks}.
+    # @return [void]
+    def self.dont_create_on_demand; end
+    
+    # Returns the pointer to the active log target (may be nil).
+    # 
+    # Notice that if {Wx::Log.set_active_target} hadn't been previously explicitly called, this function will by default try to create a log target by calling {Wx::AppTraits#create_log_target} which may be overridden in a user-defined traits class to change the default behaviour. You may also call {Wx::Log.dont_create_on_demand} to disable this behaviour.
+    # When this function is called from threads other than main one, auto-creation doesn't happen. But if the thread has a thread-specific log target previously set by {Wx::Log.set_thread_active_target}, it is returned instead of the global one. Otherwise, the global log target is returned.
+    # @return [Wx::Log]
+    def self.get_active_target; end
+    
+    # Sets the specified log target as the active one.
+    # 
+    # Returns the pointer to the previous active log target (may be nil). To suppress logging use a new instance of {Wx::LogNull} not nil. If the active log target is set to nil a new default log target will be created when logging occurs.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>The logging system will take ownership of the target you pass in here. However, it is your responsibility to delete the target you are replacing (i.e., the return value of this function).
+    # </p>
+    # </div>
+    # @see Wx::Log.set_thread_active_target 
+    # @param logtarget [Wx::Log] 
+    # @return [Wx::Log]
+    def self.set_active_target(logtarget) end
+    
+    # Flushes the current log target if any, does nothing if there is none.
+    # 
+    # When this method is called from the main thread context, it also flushes any previously buffered messages logged by the other threads. When it is called from the other threads it simply calls {Wx::Log#flush} on the currently active log target, so it mostly makes sense to do this if a thread has its own logger set with {Wx::Log.set_thread_active_target}.
+    # Note that when using the default log target, this method is called automatically before showing any modal dialog, in order to prevent showing several modal dialogs one after another.
+    # @return [void]
+    def self.flush_active; end
+    
+    # Resumes logging previously suspended by a call to {Wx::Log.suspend}.
+    # 
+    # All messages logged in the meanwhile will be flushed soon.
+    # @return [void]
+    def self.resume; end
+    
+    # Suspends the logging until {Wx::Log.resume} is called.
+    # 
+    # Note that the latter must be called the same number of times as the former to undo it, i.e. if you call {Wx::Log.suspend} twice you must call {Wx::Log.resume} twice as well.
+    # Note that suspending the logging means that the log sink won't be flushed periodically, it doesn't have any effect if the current log target does the logging immediately without waiting for {Wx::Log#flush} to be called (the standard GUI log target only shows the log dialog when it is flushed, so {Wx::Log.suspend} works as expected with it).
+    # @see Wx::Log.resume
+    # @see  Wx::LogNull 
+    # @return [void]
+    def self.suspend; end
+    
+    # Returns the current log level limit.
+    # 
+    # All messages at levels strictly greater than the value returned by this function are not logged at all.
+    # Note that this function is not thread-safe and should only be used from the main thread.
+    # @see Wx::Log.set_log_level
+    # @see  Wx::Log.is_level_enabled 
+    # @return [Wx::LogLevel]
+    def self.get_log_level; end
+    
+    # Returns true if logging at this level is enabled for the current thread.
+    # 
+    # This function only returns true if logging is globally enabled and if level is less than or equal to the maximal log level enabled for the given component.
+    # Note that this function is not thread-safe and should only be used from the main thread.
+    # @see Wx::Log.is_enabled
+    # @see  Wx::Log.set_log_level
+    # @see  Wx::Log.get_log_level
+    # @see  Wx::Log.set_component_level
+    # @param level [Wx::LogLevel] 
+    # @param component [String] 
+    # @return [Boolean]
+    def self.is_level_enabled(level, component) end
+    
+    # Sets the log level for the given component.
+    # 
+    # For example, to disable all but error messages from wxWidgets network classes you may use 
+    # ```ruby
+    #   Wx::Log.set_component_level('wx/net', Wx::LOG_Error)
+    # ```
+    # 
+    # {Wx::Log.set_log_level} may be used to set the global log level.
+    # @param component [String]  Non-empty component name, possibly using slashes (<code>/</code>) to separate it into several parts.
+    # @param level [Wx::LogLevel]  Maximal level of log messages from this component which will be handled instead of being simply discarded.
+    # @return [void]
+    def self.set_component_level(component, level) end
+    
+    # Specifies that log messages with level greater (numerically) than logLevel should be ignored and not sent to the active log target.
+    # 
+    # Note that this function is not thread-safe and can only be called from the main thread. To temporarily disable logging from the other threads, use {Wx::LogNull}, which is safe to use from them.
+    # @see Wx::Log.set_component_level 
+    # @param logLevel [Wx::LogLevel] 
+    # @return [void]
+    def self.set_log_level(logLevel) end
+    
+    # Globally enable or disable logging.
+    # 
+    # Calling this function with false argument disables all log messages for the current thread.
+    # This function is thread-safe and can be called by multiple threads concurrently.
+    # 
+    # The old state, i.e. true if logging was previously enabled and false if it was disabled.
+    # @see Wx::LogNull
+    # @see  Wx::Log.is_enabled
+    # @param enable [Boolean] 
+    # @return [Boolean]
+    def self.enable_logging(enable=true) end
+    
+    # Returns true if logging is enabled at all now.
+    # 
+    # This function is thread-safe and can be called by multiple threads concurrently.
+    # @see Wx::Log.is_level_enabled
+    # @see  Wx::Log.enable_logging 
+    # @return [Boolean]
+    def self.is_enabled; end
+    
+    # Returns whether the repetition counting mode is enabled.
+    # @return [Boolean]
+    def self.get_repetition_counting; end
+    
+    # Enables logging mode in which a log message is logged once, and in case exactly the same message successively repeats one or more times, only the number of repetitions is logged.
+    # @param repetCounting [Boolean] 
+    # @return [void]
+    def self.set_repetition_counting(repetCounting=true) end
+    
+    # Returns the current timestamp format string.
+    # 
+    # Notice that the current time stamp is only used by the default log formatter and custom formatters may ignore this format.
+    # The default time stamp is X, i.e. locale-dependent time representation.
+    # @see Wx::Log.set_timestamp 
+    # @return [Wx::String]
+    def self.get_timestamp; end
+    
+    # Sets the timestamp format prepended by the default log targets to all messages.
+    # 
+    # The string may contain any normal characters as well as % prefixed format specifiers, see strftime() manual for details. Passing an empty string to this function disables message time stamping.
+    # Notice that the current time stamp is only used by the default log formatter and custom formatters may ignore this format. You can also define a custom {Wx::LogFormatter} to customize the time stamp handling beyond changing its format.
+    # In addition to calling this function explicitly, it can also be called implicitly by wxWidgets if WXLOG_TIME_FORMAT environment variable is set, see overview of the environment variables affecting wxWidgets programs.
+    # @param format [String] 
+    # @return [void]
+    def self.set_timestamp(format) end
+    
+    # Disables time stamping of the log messages.
+    # 
+    # Notice that the current time stamp is only used by the default log formatter and custom formatters may ignore calls to this function.
+    # @return [void]
+    def self.disable_timestamp; end
+    
+    # Returns whether the verbose mode is currently active.
+    # @return [Boolean]
+    def self.get_verbose; end
+    
+    # Activates or deactivates verbose mode in which the verbose messages are logged as the normal ones instead of being silently dropped.
+    # 
+    # The verbose messages are the trace messages which are not disabled in the release mode and are generated by {log_verbose}.
+    # @see Logging Overview 
+    # @param verbose [Boolean] 
+    # @return [void]
+    def self.set_verbose(verbose=true) end
+    
+    # Show all pending output and clear the buffer.
+    # 
+    # Some of {Wx::Log} implementations, most notably the standard {Wx::LogGui} class, buffer the messages (for example, to avoid showing the user a zillion of modal message boxes one after another  which would be really annoying). This function shows them all and clears the buffer contents. If the buffer is already empty, nothing happens.
+    # If you override this method in a derived class, call the base class version first, before doing anything else.
+    # @return [void]
+    def flush; end
+    
+    # Log the given record.
+    # 
+    # This function should only be called from the DoLog() implementations in the derived classes if they need to call {Wx::Log#do_log_record} on another log object (they can, of course, just use {Wx::Log#do_log_record} call syntax to call it on the object itself). It should not be used for logging new messages which can be only sent to the currently active logger using OnLog() which also checks if the logging (for this level) is enabled while this method just directly calls DoLog().
+    # Example of use of this class from {Wx::LogChain}: 
+    # ```ruby
+    #   class Wx::LogChain
+    # 
+    #     def do_log_record(level, msg, info)
+    #        # let the previous logger show it
+    #        if m_logOld && is_passing_messages
+    #            m_logOld.log_record(level, msg, info)
+    #     
+    #        # and also send it to the new one
+    #        if m_logNew && m_logNew != self
+    #            m_logNew.log_record(level, msg, info)
+    #     end
+    # 
+    #   end
+    # ```
+    # @param level [Wx::LogLevel] 
+    # @param msg [String] 
+    # @param info [Wx::LogRecordInfo] 
+    # @return [void]
+    def log_record(level, msg, info) end
+    
+    
+    protected
+    
+    # Called to log a new record.
+    # 
+    # Any log message created by {log_xxx}, the corresponding prefix to msg and passes it to {Wx::Log#do_log_text_at_level}.
+    # You may override this method to implement custom formatting of the log messages or to implement custom filtering of log messages (e.g. you could discard all log messages coming from the given source file).
+    # @param level [Wx::LogLevel] 
+    # @param msg [String] 
+    # @param info [Wx::LogRecordInfo] 
+    # @return [void]
+    def do_log_record(level, msg, info) end
+    
+    # Called to log the specified string at given level.
+    # 
+    # The base class versions logs debug and trace messages on the system default debug output channel and passes all the other messages to {Wx::Log#do_log_text}.
+    # @param level [Wx::LogLevel] 
+    # @param msg [String] 
+    # @return [void]
+    def do_log_text_at_level(level, msg) end
+    
+    # Called to log the specified string.
+    # 
+    # A simple implementation might just send the string to stdout or stderr or save it in a file (of course, the already existing {Wx::LogStderr} can be used for this).
+    # The base class version of this function asserts so it must be overridden if you don't override {Wx::Log#do_log_record} or {Wx::Log#do_log_text_at_level}.
+    # @param msg [String] 
+    # @return [void]
+    def do_log_text(msg) end
+    
+  end # Log
+  
+  # {Wx::LogBuffer} is a very simple implementation of log sink which simply collects all the logged messages in a string (except the debug messages which are output in the usual way immediately as we're presumably not interested in collecting them for later).
+  # 
+  # The messages from different log function calls are separated by the new lines.
+  # All the messages collected so far can be shown to the user (and the current buffer cleared) by calling the overloaded {Wx::LogBuffer#flush} method.
+  # 
+  # Category:  {Wx::Logging}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
+  class LogBuffer < Log
+  
+    # The default ctor does nothing.
+    # @return [Wx::LogBuffer]
+    def initialize; end
+    
+    # Clear all the messages in the buffer.
+    # 
+    # This can be done to prevent them from being flushed by the next call to {Wx::LogBuffer#flush}, which happens implicitly if this logger ceases to be the active logger after a call to {Wx::Log.set_active_target} with a different log target.
+    # @return [void]
+    def clear; end
+    
+    # Returns the current buffer contains.
+    # 
+    # Messages from different log function calls are separated with the new lines in the buffer. The buffer can be cleared by {Wx::LogBuffer#flush} which will also show the current contents to the user.
+    # @return [Wx::String]
+    def get_buffer; end
+    alias_method :buffer, :get_buffer
+    
+  end # LogBuffer
+  
+  # This simple class allows you to chain log sinks, that is to install a new sink but keep passing log messages to the old one instead of replacing it completely as {Wx::Log.set_active_target} does.
+  # 
+  # It is especially useful when you want to divert the logs somewhere (for example to a file or a log window) but also keep showing the error messages using the standard dialogs as {Wx::LogGui} does by default.
+  # Example of usage:
+  # 
+  # ```ruby
+  #   logChain = Wx::LogChain.new(Wx::LogStderr.new)
+  #   
+  #   # all the log messages are sent to stderr and also processed as usually
+  #   ...
+  # ```
+  # 
+  # Category:  {Wx::Logging}
+  # 
+  # @wxrb_require USE_LOG
+  class LogChain < Log
+  
+    # Sets the specified logger (which may be nil) as the default log target but the log messages are also passed to the previous log target if any.
+    # @param logger [Wx::Log] 
+    # @return [Wx::LogChain]
+    def initialize(logger) end
+    
+    # Returns the pointer to the previously active log target (which may be nil).
+    # @return [Wx::Log]
+    def get_old_log; end
+    alias_method :old_log, :get_old_log
+    
+    # Returns true if the messages are passed to the previously active log target (default) or false if {Wx::LogChain#pass_messages} had been called.
+    # @return [Boolean]
+    def is_passing_messages; end
+    alias_method :passing_messages?, :is_passing_messages
+    
+    # By default, the log messages are passed to the previously active log target.
+    # 
+    # Calling this function with false parameter disables this behaviour (presumably temporarily, as you shouldn't use {Wx::LogChain} at all otherwise) and it can be re-enabled by calling it again with passMessages set to true.
+    # @param passMessages [Boolean] 
+    # @return [void]
+    def pass_messages(passMessages) end
+    
+    # Sets another log target to use (may be nil).
+    # 
+    # The log target specified in the {Wx::LogChain#initialize(wxLog)} constructor or in a previous call to this function is deleted. This doesn't change the old log target value (the one the messages are forwarded to) which still remains the same as was active when {Wx::LogChain} object was created.
+    # @param logger [Wx::Log] 
+    # @return [void]
+    def set_log(logger) end
+    alias_method :log=, :set_log
+    
+    
+    protected
+    
+  end # LogChain
+  
+  # This is the default log target for the GUI wxWidgets applications.
+  # 
+  # Please see Logging Customization for explanation of how to change the default log target.
+  # An object of this class is used by default to show the log messages created by using {log_message}, {log_error} and other logging functions. It doesn't display the messages logged by them immediately however but accumulates all messages logged during an event handler execution and then shows them all at once when its {Wx::LogGui#flush} method is called during the idle time processing. This has the important advantage of showing only a single dialog to the user even if several messages were logged because of a single error as it often happens (e.g. a low level function could log a message because it failed to open a file resulting in its caller logging another message due to the failure of higher level operation requiring the use of this file). If you need to force the display of all previously logged messages immediately you can use {Wx::Log.flush_active} to force the dialog display.
+  # Also notice that if an error message is logged when several informative messages had been already logged before, the informative messages are discarded on the assumption that they are not useful  and may be confusing and hence harmful  any more after the error. The warning and error messages are never discarded however and any informational messages logged after the first error one are also kept (as they may contain information about the error recovery). You may override DoLog() method to change this behaviour.
+  # At any rate, it is possible that that several messages were accumulated before this class {Wx::LogGui#flush} method is called. If this is the case, {Wx::LogGui#flush} uses a custom dialog which shows the last message directly and allows the user to view the previously logged ones by expanding the "Details" {Wx::CollapsiblePane} inside it. This custom dialog also provides the buttons for copying the log messages to the clipboard and saving them to a file.
+  # However if only a single message is present when {Wx::LogGui#flush} is called, just a {message_box} is used to show it. This has the advantage of being closer to the native behaviour but it doesn't give the user any possibility to copy or save the message (except for the recent Windows versions where <code>Ctrl-C</code> may be pressed in the message box to copy its contents to the clipboard) so you may want to override {Wx::LogGui#do_show_single_log_message} to customize {Wx::LogGui}  the dialogs sample shows how to do this.
+  # 
+  # Category:  {Wx::Logging}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
+  class LogGui < Log
+  
+    # Default constructor.
+    # @return [Wx::LogGui]
+    def initialize; end
+    
+  end # LogGui
+  
+  # This class can be used to redirect the log messages to a C file stream (not to be confused with C++ streams).
+  # 
+  # It is the default log target for the non-GUI wxWidgets applications which send all the output to stderr.
+  # 
+  # Category:  {Wx::Logging}
+  # @see Wx::LogStream 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
+  class LogStderr < Log
+  
+  end # LogStderr
+  
+  # Using these target all the log messages can be redirected to a text control.
+  # 
+  # The text control must have been created with {Wx::TE_MULTILINE} style by the caller previously.
+  # 
+  # Category:  {Wx::Logging}
+  # @see Wx::TextCtrl
+  # @see  Wx::StreamToTextRedirector 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
+  class LogTextCtrl < Log
+  
+    # Constructs a log target which sends all the log messages to the given text control.
+    # 
+    # The textctrl parameter cannot be nil.
+    # @param pTextCtrl [Wx::TextCtrl] 
+    # @return [Wx::LogTextCtrl]
+    def initialize(pTextCtrl) end
+    
+  end # LogTextCtrl
+  
+  # A special version of {Wx::LogChain} which uses itself as the new log target.
+  # 
+  # It forwards log messages to the previously installed one in addition to processing them itself.
+  # Unlike {Wx::LogChain} which is usually used directly as is, this class must be derived from to implement {Wx::Log::DoLog} and/or {Wx::Log::DoLogString} methods.
+  # {Wx::LogInterposer} destroys the previous log target in its destructor. If you don't want this to happen, use {Wx::LogInterposerTemp} instead.
+  # 
+  # Category:  {Wx::Logging}
+  # 
+  # @wxrb_require USE_LOG
+  class LogInterposer < LogChain
+  
+    # The default constructor installs this object as the current active log target.
+    # @return [Wx::LogInterposer]
+    def initialize; end
+    
+  end # LogInterposer
+  
+  # This class represents a background log window: to be precise, it collects all log messages in the log frame which it manages but also passes them on to the log target which was active at the moment of its creation.
+  # 
+  # This allows you, for example, to show all the log messages in a frame but still continue to process them normally by showing the standard log dialog.
+  # 
+  # Category:  {Wx::Logging}
+  # @see Wx::LogTextCtrl 
+  # 
+  # 
+  # @wxrb_require USE_LOG
+  class LogWindow < LogInterposer
+  
+    # Creates the log frame window and starts collecting the messages in it.
+    # @param pParent [Wx::Window]  The parent window for the log frame, may be nil
+    # @param szTitle [String]  The title for the log frame
+    # @param show [Boolean]  true to show the frame initially (default), otherwise {Wx::LogWindow#show} must be called later.
+    # @param passToOld [Boolean]  true to process the log messages normally in addition to logging them in the log frame (default), false to only log them in the log frame. Note that if no targets were set using {Wx::Log.set_active_target} then {Wx::LogWindow} simply becomes the active one and messages won't be passed to other targets.
+    # @return [Wx::LogWindow]
+    def initialize(pParent, szTitle, show=true, passToOld=true) end
+    
+    # Returns the associated log frame window.
+    # 
+    # This may be used to position or resize it but use {Wx::LogWindow#show} to show or hide it.
+    # @return [Wx::Frame]
+    def get_frame; end
+    alias_method :frame, :get_frame
+    
+    # Called if the user closes the window interactively, will not be called if it is destroyed for another reason (such as when program exits).
+    # 
+    # Return true from here to allow the frame to close, false to prevent this from happening.
+    # @see Wx::LogWindow#on_frame_delete 
+    # @param frame [Wx::Frame] 
+    # @return [Boolean]
+    def on_frame_close(frame) end
+    
+    # Called right before the log frame is going to be deleted: will always be called unlike {Wx::LogWindow#on_frame_close}.
+    # @param frame [Wx::Frame] 
+    # @return [void]
+    def on_frame_delete(frame) end
+    
+    # Shows or hides the frame.
+    # @param show [Boolean] 
+    # @return [void]
+    def show(show=true) end
+    
+  end # LogWindow
+  
+  # This class allows you to temporarily suspend logging.
+  # 
+  # All calls to the log functions during the life time of an object of this class are just ignored.
+  # In particular, it can be used to suppress the log messages given by wxWidgets itself but it should be noted that it is rarely the best way to cope with this problem as <b>all</b> log messages are suppressed, even if they indicate a completely different error than the one the programmer wanted to suppress.
+  # For instance, the example of the overview:
+  # 
+  # ```ruby
+  #   mime_type = ... # retrieved from somewhere
+  #   img = Wx::Image.new
+  #   Wx::LogNull.no_log do     # suspend logging 
+  # 
+  #     # Wx::Image#load_stream will complain if there is no handler for the given mimetype and fail
+  #     if !img.load_stream(File.open('file.img'), mime_type)
+  #       # handle problem
+  #     end
+  # 
+  #   end # old log sink restored
+  #   
+  #   Wx.log_message('...') # ok
+  # ```
+  # 
+  # would be better written as:
+  # 
+  # ```ruby
+  #   mime_type = ... # retrieved from somewhere
+  # 
+  #   # check the condition that makes your code complain
+  #   if Wx::Image.mime_types.include?(mime_type)
+  #     img.load_stream(File.open('file.img'), mime_type)
+  #     ...
+  #   else
+  #     # do something else
+  #     ...
+  #   end
+  # ```
+  # 
+  # Category:  {Wx::Logging}
+  # @see Wx::LogCollector
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
+  class LogNull < ::Object
+  
+  end # LogNull
+  
+  # Information about a log record (unit of the log output).
+  # 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
+  class LogRecordInfo < ::Object
+  
+  end # LogRecordInfo
+  
+
+end

data/lib/wx/doc/gen/mdi_client_window.rb

@@ -0,0 +1,47 @@
+# :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.
+  # 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>
+  # </p>
+  # </div>
+  # 
+  # 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 
+  # 
+  # 
+  # @wxrb_require USE_MDI
+  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