wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,102 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Connects an overlay with a drawing DC.
+  # 
+  # Note that when using {Wx::DCOverlay} with {Wx::ClientDC}, which is the most common case, using {Wx::OverlayDC} class is simpler and so is recommended.
+  # @see Wx::Overlay
+  # @see  Wx::DC
+  # @see  Wx::OverlayDC 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class DCOverlay < ::Object
+  
+    # Clears the layer, restoring the state at the last init.
+    # @return [void]
+    def clear; end
+    
+  end # DCOverlay
+  
+  # Creates an overlay over an existing window, allowing for manipulations like rubber-banding, etc.
+  # 
+  # Overlay is implemented internally as a native window shown on top of the window it is used with and it is more efficient to keep the {Wx::Overlay} object around instead of recreating it every time it's needed, i.e. typically you would have a member variable of type {Wx::Overlay} in your window class.
+  # The overlay is initialized automatically when it is used by {Wx::DCOverlay} or {Wx::OverlayDC} but has to be cleared manually, using its {Wx::Overlay#reset} function, when its contents shouldn't be shown any longer.
+  # Use of this class is shown in the page_samples_drawing where pressing the left mouse button and dragging the mouse creates a rubber band effect using {Wx::Overlay}.
+  # @see Wx::DCOverlay
+  # @see  Wx::OverlayDC 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class Overlay < ::Object
+  
+    # @return [Wx::Overlay]
+    def initialize; end
+    
+    # Clears the overlay without restoring the former state.
+    # 
+    # To be done, for example, when the window content has been changed and repainted.
+    # @return [void]
+    def reset; end
+    
+    # Sets or unsets constant opacity of the overlay window.
+    # 
+    # If alpha is <code>-1</code>, use per-pixel alpha blending, otherwise use the given alpha value for all pixels.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Drawing on the overlay window is opaque by default under WXMSW. You have to call SetOpacity(-1) before initializing the overlay and use a graphics context to do the actual drawing if you want per-pixel alpha blending. Or, assuming that SetOpacity(-1) wasn't called, explicitly set the alpha value (at any time) to change the overlay window's opacity.
+    # </p>
+    # </div>
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This is currently only implemented for WXMSW and does nothing in the other ports.
+    # </p>
+    # </div>
+    # @param alpha [Integer] 
+    # @return [void]
+    def set_opacity(alpha) end
+    alias_method :opacity=, :set_opacity
+    
+  end # Overlay
+  
+  # A device context allowing to draw on an overlay associated with a window.
+  # 
+  # Assuming MyWindow as a {Wx::Window}-derived object with <code>Wx::Overlay m_overlay</code> as a member variable, this class could be used in the following way:
+  # 
+  # ```
+  #   void MyWindow::OnDrawSomethingTemporary()
+  #   {
+  #       wxOverlayDC dc(m_overlay, this);
+  #       dc.Clear(); // Usually required, unless the entire DC is filled.
+  #   
+  #       // Use wxDC functions as usual.
+  #       dc.DrawText("Hello, world!", 10, 10);
+  #   }
+  #   
+  #   void MyWindow::OnClearTemporaryDrawing()
+  #   {
+  #       m_overlay.Reset();
+  #   }
+  # ```
+  # 
+  # Note that while {Wx::OverlayDC} currently actually inherits from {Wx::ClientDC}, this is an implementation detail and shouldn't be relied upon, it is only guaranteed to derive from {Wx::DC} as documented here.
+  # @see Wx::Overlay
+  # @see  Wx::DCOverlay
+  # @see  Wx::DC
+  # 
+  # 
+  class OverlayDC < DC
+  
+  end # OverlayDC
+  
+
+end