wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,117 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  MC_NO_AUTORESIZE = 1
+  
+  # Describes the current state of the media.
+  # 
+  # 
+  # @see Wx::MediaCtrl#get_state 
+  # 
+  # 
+  # @wxrb_require USE_MEDIACTRL
+  class MediaState < Wx::Enum
+  
+    # No media is being currently played.
+    # 
+    MEDIASTATE_STOPPED = Wx::MediaState.new(0)
+    
+    # Current media is paused.
+    # 
+    MEDIASTATE_PAUSED = Wx::MediaState.new(1)
+    
+    # There is media currently playing.
+    # 
+    MEDIASTATE_PLAYING = Wx::MediaState.new(2)
+    
+  end # MediaState
+  
+  # 
+  # 
+  # 
+  # 
+  # @wxrb_require USE_MEDIACTRL
+  class MediaCtrlPlayerControls < Wx::Enum
+  
+    # No controls.
+    # 
+    MEDIACTRLPLAYERCONTROLS_NONE = Wx::MediaCtrlPlayerControls.new(0)
+    
+    # Step controls like fastforward, step one frame etc.
+    # 
+    MEDIACTRLPLAYERCONTROLS_STEP = Wx::MediaCtrlPlayerControls.new(1)
+    
+    # Volume controls like the speaker icon, volume slider, etc.
+    # 
+    MEDIACTRLPLAYERCONTROLS_VOLUME = Wx::MediaCtrlPlayerControls.new(2)
+    
+    # Default controls for the toolkit.
+    # 
+    MEDIACTRLPLAYERCONTROLS_DEFAULT = Wx::MediaCtrlPlayerControls.new(3)
+    
+  end # MediaCtrlPlayerControls
+  
+  # 
+  # 
+  EVT_MEDIA_LOADED = 10334
+  
+  # 
+  # 
+  EVT_MEDIA_STOP = 10335
+  
+  # 
+  # 
+  EVT_MEDIA_FINISHED = 10333
+  
+  # 
+  # 
+  EVT_MEDIA_STATECHANGED = 10330
+  
+  # 
+  # 
+  EVT_MEDIA_PLAY = 10331
+  
+  # 
+  # 
+  EVT_MEDIA_PAUSE = 10332
+  
+  # Event {Wx::MediaCtrl} uses.
+  # 
+  # ### Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MediaEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_media_loaded}(id, meth = nil, &block): Sent when a media has loaded enough data that it can start playing. Processes a {Wx::EVT_MEDIA_LOADED} event type. 
+  # 
+  # - {Wx::EvtHandler#evt_media_stop}(id, meth = nil, &block): Sent when a media has switched to the {Wx::MediaState::MEDIASTATE_STOPPED} state. You may be able to Veto this event to prevent it from stopping, causing it to continue playing - even if it has reached that end of the media (note that this may not have the desired effect - if you want to loop the media, for example, catch the EVT_MEDIA_FINISHED and play there instead). Processes a {Wx::EVT_MEDIA_STOP} event type. 
+  # 
+  # - {Wx::EvtHandler#evt_media_finished}(id, meth = nil, &block): Sent when a media has finished playing in a {Wx::MediaCtrl}. Processes a {Wx::EVT_MEDIA_FINISHED} event type. 
+  # 
+  # - {Wx::EvtHandler#evt_media_statechanged}(id, meth = nil, &block): Sent when a media has switched its state (from any media state). Processes a {Wx::EVT_MEDIA_STATECHANGED} event type. 
+  # 
+  # - {Wx::EvtHandler#evt_media_play}(id, meth = nil, &block): Sent when a media has switched to the {Wx::MediaState::MEDIASTATE_PLAYING} state. Processes a {Wx::EVT_MEDIA_PLAY} event type. 
+  # 
+  # - {Wx::EvtHandler#evt_media_pause}(id, meth = nil, &block): Sent when a media has switched to the {Wx::MediaState::MEDIASTATE_PAUSED} state. Processes a {Wx::EVT_MEDIA_PAUSE} event type. 
+  # 
+  # Category:  {Wx::Events}
+  # 
+  # @wxrb_require USE_MEDIACTRL
+  class MediaEvent < NotifyEvent
+  
+    # Default ctor.
+    # @param commandType [Wx::TipWindow::EventType] 
+    # @param winid [Integer] 
+    # @return [Wx::MediaEvent]
+    def initialize(commandType=Wx::EVT_NULL, winid=0) end
+    
+  end # MediaEvent
+  
+
+end

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

@@ -0,0 +1,174 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  BUFFER_VIRTUAL_AREA = 1
+  
+  # 
+  BUFFER_CLIENT_AREA = 2
+  
+  # 
+  BUFFER_USES_SHARED_BUFFER = 4
+  
+  # Check if the window is natively double buffered and will return a {Wx::PaintDC} if it is, a {Wx::BufferedPaintDC} otherwise.
+  # 
+  # It is the caller's responsibility to delete the {Wx::DC} pointer when finished with it.
+  # @param window [Wx::Window] 
+  # @return [Wx::DC]
+  def self.auto_buffered_paint_dc_factory(window) end
+  
+  # A memory device context provides a means to draw graphics onto a bitmap.
+  # 
+  # When drawing in to a mono-bitmap, using {Wx::WHITE}, {Wx::WHITE_PEN} and {Wx::WHITE_BRUSH} will draw the background colour (i.e. 0) whereas all other colours will draw the foreground colour (i.e. 1).
+  # A bitmap must be selected into the new memory DC before it may be used for anything. Typical usage is as follows:
+  # 
+  # ```ruby
+  #   Wx::MemoryDC.draw_on(test_bitmap) do |mem_dc|
+  #     # We can now draw into the memory DC...
+  #     
+  #     # Copy from this DC to another DC.
+  #     old_dc.blit(250, 50, BITMAP_WIDTH, BITMAP_HEIGHT, mem_dc, 0, 0)
+  #   end
+  # ```
+  # 
+  # Note that the memory DC must be deleted (or the bitmap selected out of it) before a bitmap can be reselected into another memory DC.
+  # And, before performing any other operations on the bitmap data, the bitmap must be selected out of the memory DC. Note that when using the `.draw_on` method this will happen automatically when the block returns.
+  # 
+  # Note that the scaling factor of the bitmap determines the scaling factor used by this device context, so when using a memory device context as a back buffer for a window, you should create the bitmap using the same scale factor as the one used by the window itself, e.g. 
+  # ```ruby
+  #   class MyWindow
+  # 
+  #     def on_paint(_)
+  #       bmp = Wx::Bitmap.new
+  #       bmp.create_with_dip_size(get_client_size, get_dpi_scale_factor)
+  #       Wx::MemoryDC.draw_on(bmp) do |mem_dc|  
+  #         ... use mem_dc to draw on the bitmap ...
+  #       end
+  #       self.paint do |dc|
+  #         dc.draw_bitmap(bmp, Wx::Point.new(0, 0))
+  #       end
+  #     end
+  # 
+  #   end
+  # ```
+  # 
+  # Category:  Device Contexts
+  # @see Wx::Bitmap
+  # @see  Wx::DC 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class MemoryDC < DC
+  
+    # Allow using this device context object to modify the given bitmap contents.
+    # 
+    # Note that if you need to only use the existing bitmap contents instead of modifying it, you should use {Wx::MemoryDC#select_object_as_source} instead.
+    # Before using the updated bitmap data, make sure to select it out of context first either by selecting {Wx::NULL_BITMAP} into the device context or destroying the device context entirely.
+    # If the bitmap is already selected in this device context, nothing is done. If it is selected in another context, the function asserts and drawing on the bitmap won't work correctly.
+    # Note that this function changes the scale factor of this device context (as returned by {Wx::DC#get_content_scale_factor}) to be the same as the bitmap scale factor (as returned by {Wx::Bitmap#get_scale_factor}).
+    # @param bitmap [Wx::Bitmap] 
+    # @return [void]
+    def select_object(bitmap) end
+    
+    # Selects the given bitmap into the device context, to use as the memory bitmap.
+    # 
+    # Selecting the bitmap as source into a memory DC allows you to copy its contents to another device context using {Wx::DC#blit}. Note that using {Wx::DC#draw_bitmap} or {Wx::DC#draw_icon} is a simpler way to do the same thing.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Modifying a bitmap selected only as a source may not work correctly and can notably modify the other bitmaps sharing the same data due to the use of reference counting (see Reference Counting).
+    # </p>
+    # </div>
+    # 
+    # If the argument is {Wx::NULL_BITMAP} (or some other uninitialised {Wx::Bitmap}) the current bitmap is selected out of the device context, allowing the current bitmap to be destroyed safely.
+    # @param bitmap [Wx::Bitmap] 
+    # @return [void]
+    def select_object_as_source(bitmap) end
+    
+    # Get the selected bitmap.
+    # @return [Wx::Bitmap]
+    def get_selected_bitmap; end
+    alias_method :selected_bitmap, :get_selected_bitmap
+    
+  end # MemoryDC
+  
+  # This class provides a simple way to avoid flicker: when drawing on it, everything is in fact first drawn on an in-memory buffer (a {Wx::Bitmap}) and then copied to the screen, using the associated {Wx::DC}, only once, when this object is destroyed.
+  # 
+  # {Wx::BufferedDC} itself is typically associated with {Wx::ClientDC}, if you want to use it in your EVT_PAINT handler, you should look at {Wx::BufferedPaintDC} instead.
+  # When used like this, a valid DC must be specified in the constructor while the buffer bitmap doesn't have to be explicitly provided, by default this class will allocate the bitmap of required size itself. However using a dedicated bitmap can speed up the redrawing process by eliminating the repeated creation and destruction of a possibly big bitmap. Otherwise, {Wx::BufferedDC} can be used in the same way as any other device context.
+  # Another possible use for {Wx::BufferedDC} is to use it to maintain a backing store for the window contents. In this case, the associated DC may be nil but a valid backing store bitmap should be specified.
+  # Finally, please note that GTK+ 2.0 as well as macOS provide double buffering themselves natively. You can either use {Wx::Window#is_double_buffered} to determine whether you need to use buffering or not, or use {Wx::AutoBufferedPaintDC} to avoid needless double buffering on the systems which already do it automatically.
+  # 
+  # Category:  Device Contexts
+  # @see Wx::DC
+  # @see  Wx::MemoryDC
+  # @see  Wx::BufferedPaintDC
+  # @see  Wx::AutoBufferedPaintDC 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class BufferedDC < MemoryDC
+  
+    # @overload init(dc, area, style=Wx::BUFFER_CLIENT_AREA)
+    #   Initializes the object created using the default constructor.
+    #   
+    #   Please see the constructors for parameter details.
+    #   @param dc [Wx::DC] 
+    #   @param area [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @return [void]
+    # @overload init(dc, buffer=Wx::NULL_BITMAP, style=Wx::BUFFER_CLIENT_AREA)
+    #   Initializes the object created using the default constructor.
+    #   
+    #   Please see the constructors for parameter details.
+    #   @param dc [Wx::DC] 
+    #   @param buffer [Wx::Bitmap] 
+    #   @param style [Integer] 
+    #   @return [void]
+    def init(*args) end
+    
+    # Blits the buffer to the dc, and detaches the dc from the buffer (so it can be effectively used once only).
+    # 
+    # Usually only called in the destructor or by the destructor of derived classes if the BufferedDC must blit before the derived class (which may own the dc it's blitting to) is destroyed.
+    # @return [void]
+    def un_mask; end
+    
+    # Set the style.
+    # @param style [Integer] 
+    # @return [void]
+    def set_style(style) end
+    alias_method :style=, :set_style
+    
+    # Get the style.
+    # @return [Integer]
+    def get_style; end
+    alias_method :style, :get_style
+    
+  end # BufferedDC
+  
+  # This is a subclass of {Wx::BufferedDC} which can be used inside of an <code>EVT_PAINT()</code> event handler to achieve double-buffered drawing.
+  # 
+  # Just use this class instead of {Wx::PaintDC} and make sure {Wx::Window#set_background_style} is called with {Wx::BackgroundStyle::BG_STYLE_PAINT} somewhere in the class initialization code, and that's all you have to do to (mostly) avoid flicker. The only thing to watch out for is that if you are using this class together with {Wx::Scrolled}, you probably do <b>not</b> want to call Wx::Scrolled#prepare_dc on it as it already does this internally for the real underlying {Wx::PaintDC}.
+  # 
+  # Category:  Device Contexts
+  # @see Wx::DC
+  # @see  Wx::BufferedDC
+  # @see  Wx::AutoBufferedPaintDC
+  # @see  Wx::PaintDC 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class BufferedPaintDC < BufferedDC
+  
+  end # BufferedPaintDC
+  
+
+end