# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx # FRAME_SHAPED = 16 # Common base class for all non-child windows. # This is the common base class of {Wx::TopLevelWindow} and {Wx::PopupWindow} and is not used directly. # Currently the only additional functionality it provides, compared to base {Wx::Window} class, is the ability to set the window shape. # class NonOwnedWindow < Window # @overload set_shape(region) # If the platform supports it, sets the shape of the window to that depicted by region. # The system will not display or respond to any mouse event for the pixels that lie outside of the region. To reset the window to the normal rectangular shape simply call {Wx::NonOwnedWindow#set_shape} again with an empty {Wx::Region}. Returns true if the operation is successful. # This method is available in this class only since wxWidgets 2.9.3, previous versions only provided it in {Wx::TopLevelWindow}. # Note that windows with non default shape have a fixed size and can't be resized using {Wx::NonOwnedWindow#set_size}. # @param region [Wx::Region] # @return [Boolean] # @overload set_shape(path) # Set the window shape to the given path. # Set the window shape to the interior of the given path and also draw the window border along the specified path. # For example, to make a clock-like circular window you could use # ```ruby # size = get_size # path = Wx::GraphicsRenderer.get_default_renderer.create_path # path.add_circle(size.x/2, size.y/2, 30) # set_shape(path) # ``` # # Note that windows with non default shape have a fixed size and can't be resized using {Wx::NonOwnedWindow#set_size}. # As the overload above, this method is not guaranteed to work on all platforms but currently does work in wxMSW, wxOSX/Cocoa and wxGTK (with the appropriate but almost always present X11 extensions) ports. # @param path [Wx::GraphicsPath] # @return [Boolean] def set_shape(*args) end alias_method :shape=, :set_shape end # NonOwnedWindow end