wxruby3 0.9.0.pre.rc.3-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

data/lib/wx/doc/gen/rtc/rich_text_image.rb

@@ -0,0 +1,328 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::RTC
+
+  # This class implements a graphic object.
+  # === 
+  # 
+  # Category:  Rich Text
+  # @see Wx::RTC::RichTextBuffer
+  # @see  Wx::RTC::RichTextCtrl
+  # @see  Wx::RTC::RichTextImageBlock 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class RichTextImage < RichTextObject
+  
+    # @overload initialize(parent=nil)
+    #   Default constructor.
+    #   @param parent [Wx::RTC::RichTextObject] 
+    #   @return [Wx::RTC::RichTextImage]
+    # @overload initialize(image, parent=nil, charStyle=nil)
+    #   Creates a {Wx::RTC::RichTextImage} from a {Wx::Image}.
+    #   @param image [Wx::Image] 
+    #   @param parent [Wx::RTC::RichTextObject] 
+    #   @param charStyle [Wx::RTC::RichTextAttr] 
+    #   @return [Wx::RTC::RichTextImage]
+    # @overload initialize(imageBlock, parent=nil, charStyle=nil)
+    #   Creates a {Wx::RTC::RichTextImage} from an image block.
+    #   @param imageBlock [Wx::RTC::RichTextImageBlock] 
+    #   @param parent [Wx::RTC::RichTextObject] 
+    #   @param charStyle [Wx::RTC::RichTextAttr] 
+    #   @return [Wx::RTC::RichTextImage]
+    # @overload initialize(obj)
+    #   Copy constructor.
+    #   @param obj [Wx::RTC::RichTextImage] 
+    #   @return [Wx::RTC::RichTextImage]
+    def initialize(*args) end
+    
+    # Draw the item, within the given range.
+    # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
+    # @param dc [Wx::DC] 
+    # @param context [Wx::RTC::RichTextDrawingContext] 
+    # @param range [Range] 
+    # @param selection [Wx::RTC::RichTextSelection] 
+    # @param rect [Wx::Rect] 
+    # @param descent [Integer] 
+    # @param style [Integer] 
+    # @return [Boolean]
+    def draw(dc, context, range, selection, rect, descent, style) end
+    
+    # Lay the item out at the specified position with the given size constraint.
+    # Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).
+    # @param dc [Wx::DC] 
+    # @param context [Wx::RTC::RichTextDrawingContext] 
+    # @param rect [Wx::Rect] 
+    # @param parentRect [Wx::Rect] 
+    # @param style [Integer] 
+    # @return [Boolean]
+    def layout(dc, context, rect, parentRect, style) end
+    
+    # Returns the object size for the given range.
+    # Returns false if the range is invalid for this object.
+    # @param range [Range] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param descent [int] 
+    # @param dc [Wx::DC] 
+    # @param context [Wx::RTC::RichTextDrawingContext] 
+    # @param flags [Integer] 
+    # @param position [Array(Integer, Integer), Wx::Point] 
+    # @param parentSize [Array(Integer, Integer), Wx::Size] 
+    # @param partialExtents [Array,nil] 
+    # @return [Boolean]
+    def get_range_size(range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
+    alias_method :range_size, :get_range_size
+    
+    # Returns the 'natural' size for this object - the image size.
+    # @return [Wx::RTC::TextAttrSize]
+    def get_natural_size; end
+    alias_method :natural_size, :get_natural_size
+    
+    # Returns true if the object is empty.
+    # @return [Boolean]
+    def is_empty; end
+    alias_method :empty?, :is_empty
+    
+    # Returns true if we can edit the object's properties via a GUI.
+    # @return [Boolean]
+    def can_edit_properties; end
+    alias_method :can_edit_properties?, :can_edit_properties
+    
+    # Edits the object's properties via a GUI.
+    # @param parent [Wx::Window] 
+    # @param buffer [Wx::RTC::RichTextBuffer] 
+    # @return [Boolean]
+    def edit_properties(parent, buffer) end
+    
+    # Returns the label to be used for the properties context menu item.
+    # @return [String]
+    def get_properties_menu_label; end
+    alias_method :properties_menu_label, :get_properties_menu_label
+    
+    # Returns true if this object takes note of paragraph attributes (text and image objects don't).
+    # @return [Boolean]
+    def uses_paragraph_attributes; end
+    
+    # Imports this object from XML.
+    # @param buffer [Wx::RTC::RichTextBuffer] 
+    # @param node [Wx::XmlNode] 
+    # @param handler [Wx::RTC::RichTextXMLHandler] 
+    # @param recurse [Boolean] 
+    # @return [Array(Boolean,Boolean)]
+    def import_from_xml(buffer, node, handler, recurse) end
+    
+    # Returns true if this class of object is floatable.
+    # @return [Boolean]
+    def is_floatable; end
+    alias_method :floatable?, :is_floatable
+    
+    # Returns the XML node name of this object.
+    # This must be overridden for {Wx::XmlNode}-base XML export to work.
+    # @return [String]
+    def get_xml_node_name; end
+    alias_method :xml_node_name, :get_xml_node_name
+    
+    # Returns the image cache (a scaled bitmap).
+    # @return [Wx::Bitmap]
+    def get_image_cache; end
+    alias_method :image_cache, :get_image_cache
+    
+    # Sets the image cache.
+    # @param bitmap [Wx::Bitmap] 
+    # @return [void]
+    def set_image_cache(bitmap) end
+    alias_method :image_cache=, :set_image_cache
+    
+    # Resets the image cache.
+    # @return [void]
+    def reset_image_cache; end
+    
+    # Returns the image block containing the raw data.
+    # @return [Wx::RTC::RichTextImageBlock]
+    def get_image_block; end
+    alias_method :image_block, :get_image_block
+    
+    # Gets the original image size.
+    # @return [Wx::Size]
+    def get_original_image_size; end
+    alias_method :original_image_size, :get_original_image_size
+    
+    # Sets the original image size.
+    # @param sz [Array(Integer, Integer), Wx::Size] 
+    # @return [void]
+    def set_original_image_size(sz) end
+    alias_method :original_image_size=, :set_original_image_size
+    
+    # Copies the image object.
+    # @param obj [Wx::RTC::RichTextImage] 
+    # @return [void]
+    def copy(obj) end
+    
+    # Clones the image object.
+    # @return [Wx::RTC::RichTextObject]
+    def clone; end
+    
+    # Creates a cached image at the required size.
+    # @param dc [Wx::DC] 
+    # @param context [Wx::RTC::RichTextDrawingContext] 
+    # @param retImageSize [Array(Integer, Integer), Wx::Size] 
+    # @param resetCache [Boolean] 
+    # @param parentSize [Array(Integer, Integer), Wx::Size] 
+    # @return [Boolean]
+    def load_image_cache(dc, context, retImageSize, resetCache=false, parentSize=Wx::DEFAULT_SIZE) end
+    
+    # Do the loading and scaling.
+    # @param image [Wx::Image] 
+    # @param sz [Array(Integer, Integer), Wx::Size] 
+    # @param context [Wx::RTC::RichTextDrawingContext] 
+    # @return [Array(Boolean,Boolean)]
+    def load_and_scale_image_cache(image, sz, context) end
+    
+    # Gets the image state.
+    # @return [Integer]
+    def get_image_state; end
+    alias_method :image_state, :get_image_state
+    
+    # Sets the image state.
+    # @param state [Integer] 
+    # @return [void]
+    def set_image_state(state) end
+    alias_method :image_state=, :set_image_state
+    
+  end # RichTextImage
+  
+  # This class stores information about an image, in binary in-memory form.
+  # === 
+  # 
+  # Category:  Rich Text
+  # @see Wx::RTC::RichTextBuffer
+  # @see  Wx::RTC::RichTextCtrl 
+  # 
+  # 
+  class RichTextImageBlock < Object
+  
+    # @overload initialize()
+    #   Constructor.
+    #   @return [Wx::RTC::RichTextImageBlock]
+    # @overload initialize(block)
+    #   Copy constructor.
+    #   @param block [Wx::RTC::RichTextImageBlock] 
+    #   @return [Wx::RTC::RichTextImageBlock]
+    def initialize(*args) end
+    
+    # Initialises the block.
+    # @return [void]
+    def init; end
+    
+    # Clears the block.
+    # @return [void]
+    def clear; end
+    
+    # @overload make_image_block(filename, imageType, image, convertToJPEG=true)
+    #   Load the original image into a memory block.
+    #   If the image is not a JPEG, we must convert it into a JPEG to conserve space. If it's not a JPEG we can make use of image, already scaled, so we don't have to load the image a second time.
+    #   @param filename [String] 
+    #   @param imageType [Wx::BitmapType] 
+    #   @param image [Wx::Image] 
+    #   @param convertToJPEG [Boolean] 
+    #   @return [Boolean]
+    # @overload make_image_block(image, imageType, quality=80)
+    #   Make an image block from the {Wx::Image} in the given format.
+    #   @param image [Wx::Image] 
+    #   @param imageType [Wx::BitmapType] 
+    #   @param quality [Integer] 
+    #   @return [Boolean]
+    def make_image_block(*args) end
+    
+    # Uses a const {Wx::Image} for efficiency, but can't set quality (only relevant for JPEG)
+    # @param image [Wx::Image] 
+    # @param imageType [Wx::BitmapType] 
+    # @return [Boolean]
+    def make_image_block_default_quality(image, imageType) end
+    
+    # Makes the image block.
+    # @param image [Wx::Image] 
+    # @param imageType [Wx::BitmapType] 
+    # @return [Boolean]
+    def do_make_image_block(image, imageType) end
+    
+    # Writes the block to a file.
+    # @param filename [String] 
+    # @return [Boolean]
+    def write(filename) end
+    
+    # Writes the data in hex to a stream.
+    # @param stream [IO,Wx::OutputStream] 
+    # @return [Boolean]
+    def write_hex(stream) end
+    
+    # Reads the data in hex from a stream.
+    # @param stream [IO,Wx::InputStream] 
+    # @param length [Integer] 
+    # @param imageType [Wx::BitmapType] 
+    # @return [Boolean]
+    def read_hex(stream, length, imageType) end
+    
+    # Copy from block.
+    # @param block [Wx::RTC::RichTextImageBlock] 
+    # @return [void]
+    def copy(block) end
+    
+    # @param image [Wx::Image] 
+    # @return [Boolean]
+    def load(image) end
+    
+    # Returns the raw data.
+    # @return [String]
+    def get_data; end
+    alias_method :data, :get_data
+    
+    # Returns the data size in bytes.
+    # @return [Integer]
+    def get_data_size; end
+    alias_method :data_size, :get_data_size
+    
+    # Returns the image type.
+    # @return [Wx::BitmapType]
+    def get_image_type; end
+    alias_method :image_type, :get_image_type
+    
+    # @param image [String] 
+    # @return [void]
+    def set_data(image) end
+    alias_method :data=, :set_data
+    
+    # Sets the data size.
+    # @param size [Integer] 
+    # @return [void]
+    def set_data_size(size) end
+    alias_method :data_size=, :set_data_size
+    
+    # Sets the image type.
+    # @param imageType [Wx::BitmapType] 
+    # @return [void]
+    def set_image_type(imageType) end
+    alias_method :image_type=, :set_image_type
+    
+    # Returns true if the data is non-NULL.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # @return [Boolean]
+    def ok; end
+    
+    # Gets the extension for the block's type.
+    # @return [String]
+    def get_extension; end
+    alias_method :extension, :get_extension
+    
+  end # RichTextImageBlock
+  
+
+end