wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

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

@@ -0,0 +1,236 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # The calendar control allows the user to pick a date.
+  # The user can move the current selection using the keyboard and select the date (generating EVT_CALENDAR event) by pressing <code><Return></code> or double clicking it.
+  # Generic calendar has advanced possibilities for the customization of its display, described below. If you want to use these possibilities on every platform, use {Wx::GenericCalendarCtrl} instead of {Wx::CalendarCtrl}.
+  # All global settings (such as colours and fonts used) can, of course, be changed. But also, the display style for each day in the month can be set independently using {Wx::CalendarDateAttr} class.
+  # An item without custom attributes is drawn with the default colours and font and without border, but setting custom attributes with {Wx::CalendarCtrl#set_attr} allows modifying its appearance. Just create a custom attribute object and set it for the day you want to be displayed specially (note that the control will take ownership of the pointer, i.e. it will delete it itself). A day may be marked as being a holiday, even if it is not recognized as one by {Wx::DateTime} using the {Wx::CalendarDateAttr#set_holiday} method.
+  # As the attributes are specified for each day, they may change when the month is changed, so you will often want to update them in EVT_CALENDAR_PAGE_CHANGED event handler.
+  # If neither the {Wx::CAL_SUNDAY_FIRST} or {Wx::CAL_MONDAY_FIRST} style is given, the first day of the week is determined from operating system's settings, if possible. The native {Wx::GTK} calendar chooses the first weekday based on locale, and these styles have no effect on it.
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::CAL_SUNDAY_FIRST}: Show Sunday as the first day in the week (not in {Wx::GTK}) 
+  # - {Wx::CAL_MONDAY_FIRST}: Show Monday as the first day in the week (not in {Wx::GTK}) 
+  # - {Wx::CAL_SHOW_HOLIDAYS}: Highlight holidays in the calendar (only generic) 
+  # - {Wx::CAL_NO_YEAR_CHANGE}: Disable the year changing (deprecated, only generic) 
+  # - {Wx::CAL_NO_MONTH_CHANGE}: Disable the month (and, implicitly, the year) changing 
+  # - {Wx::CAL_SHOW_SURROUNDING_WEEKS}: Show the neighbouring weeks in the previous and next months (only generic, always on for the native controls) 
+  # - {Wx::CAL_SEQUENTIAL_MONTH_SELECTION}: Use alternative, more compact, style for the month and year selection controls. (only generic) 
+  # - {Wx::CAL_SHOW_WEEK_NUMBERS}: Show week numbers on the left side of the calendar. (not in generic) 
+  # 
+  # === Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CalendarEvent} events.
+  # Event handler methods for events emitted by this class:
+  # - {Wx::EvtHandler#evt_calendar}(id, meth = nil, &block): A day was double clicked in the calendar. 
+  # - {Wx::EvtHandler#evt_calendar_sel_changed}(id, meth = nil, &block): The selected date changed. 
+  # - {Wx::EvtHandler#evt_calendar_page_changed}(id, meth = nil, &block): The selected month (and/or year) changed. 
+  # - {Wx::EvtHandler#evt_calendar_weekday_clicked}(id, meth = nil, &block): User clicked on the week day header (only generic). 
+  # - {Wx::EvtHandler#evt_calendar_week_clicked}(id, meth = nil, &block): User clicked on the week of the year number (only generic). 
+  # 
+  # Changing the selected date will trigger an EVT_CALENDAR_DAY, MONTH or YEAR event as well as an EVT_CALENDAR_SEL_CHANGED event.
+  # 
+  # === 
+  # 
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # Implementations:  native under {Wx::GTK}, {Wx::MSW} ports; a generic implementation is used elsewhere.
+  # @see Calendar Sample
+  # @see  Wx::CalendarDateAttr
+  # @see  Wx::CalendarEvent
+  # @see  Wx::DatePickerCtrl 
+  # 
+  # 
+  class CalendarCtrl < Control
+  
+    # Restrict the dates that can be selected in the control to the specified range.
+    # If either date is set, the corresponding limit will be enforced and true returned. If none are set, the existing restrictions are removed and false is returned.
+    # 
+    # true if either limit is valid, false otherwise
+    # @see Wx::CalendarCtrl#get_date_range
+    # @param lowerdate [Time,Date,DateTime]  The low limit for the dates shown by the control or {Wx::DefaultDateTime}.
+    # @param upperdate [Time,Date,DateTime]  The high limit for the dates shown by the control or {Wx::DefaultDateTime}.
+    # @return [void]
+    def set_date_range(lowerdate=Wx::DEFAULT_DATE_TIME, upperdate=Wx::DEFAULT_DATE_TIME) end
+    alias_method :date_range=, :set_date_range
+    
+    # Returns the limits currently being used.
+    # true if either limit is set, false otherwise
+    # @see Wx::CalendarCtrl#set_date_range
+    # @return [Array(Time, Time), nil]
+    def get_date_range; end
+    alias_method :date_range, :get_date_range
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [CalendarCtrl]
+    # @overload initialize(parent, id, date=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CAL_SHOW_HOLIDAYS, name=Wx::CALENDAR_NAME_STR)
+    #   Does the same as {Wx::CalendarCtrl#create} method.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param date [Time,Date,DateTime] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [CalendarCtrl]
+    def initialize(*args) end
+    
+    # Creates the control.
+    # See {Wx::Window#initialize} for the meaning of the parameters and the control overview for the possible styles.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param date [Time,Date,DateTime] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [void]
+    def create(parent, id, date=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CAL_SHOW_HOLIDAYS, name=Wx::CALENDAR_NAME_STR) end
+    
+    # This function should be used instead of changing {Wx::CAL_SHOW_HOLIDAYS} style bit directly.
+    # It enables or disables the special highlighting of the holidays.
+    # @param display [true,false] 
+    # @return [void]
+    def enable_holiday_display(display=true) end
+    
+    # This function should be used instead of changing {Wx::CAL_NO_MONTH_CHANGE} style bit.
+    # It allows or disallows the user to change the month interactively. Note that if the month cannot be changed, the year cannot be changed either.
+    # true if the value of this option really changed or false if it was already set to the requested value.
+    # @param enable [true,false] 
+    # @return [void]
+    def enable_month_change(enable=true) end
+    
+    # Returns the attribute for the given date (should be in the range 1...31).
+    # The returned pointer may be NULL. Only in generic {Wx::CalendarCtrl}.
+    # @param day [Integer] 
+    # @return [Wx::CalendarDateAttr]
+    def get_attr(day) end
+    alias_method :attr, :get_attr
+    
+    # Gets the currently selected date.
+    # @return [Time,Date,DateTime]
+    def get_date; end
+    alias_method :date, :get_date
+    
+    # Gets the background colour of the header part of the calendar window.
+    # This method is currently only implemented in generic {Wx::CalendarCtrl} and always returns {Wx::NULL_COLOUR} in the native versions.
+    # @see Wx::CalendarCtrl#set_header_colours 
+    # @return [Wx::Colour,String,Symbol]
+    def get_header_colour_bg; end
+    alias_method :header_colour_bg, :get_header_colour_bg
+    
+    # Gets the foreground colour of the header part of the calendar window.
+    # This method is currently only implemented in generic {Wx::CalendarCtrl} and always returns {Wx::NULL_COLOUR} in the native versions.
+    # @see Wx::CalendarCtrl#set_header_colours 
+    # @return [Wx::Colour,String,Symbol]
+    def get_header_colour_fg; end
+    alias_method :header_colour_fg, :get_header_colour_fg
+    
+    # Gets the background highlight colour.
+    # Only in generic {Wx::CalendarCtrl}.
+    # This method is currently only implemented in generic {Wx::CalendarCtrl} and always returns {Wx::NULL_COLOUR} in the native versions.
+    # @see Wx::CalendarCtrl#set_highlight_colours 
+    # @return [Wx::Colour,String,Symbol]
+    def get_highlight_colour_bg; end
+    alias_method :highlight_colour_bg, :get_highlight_colour_bg
+    
+    # Gets the foreground highlight colour.
+    # Only in generic {Wx::CalendarCtrl}.
+    # This method is currently only implemented in generic {Wx::CalendarCtrl} and always returns {Wx::NULL_COLOUR} in the native versions.
+    # @see Wx::CalendarCtrl#set_highlight_colours 
+    # @return [Wx::Colour,String,Symbol]
+    def get_highlight_colour_fg; end
+    alias_method :highlight_colour_fg, :get_highlight_colour_fg
+    
+    # Return the background colour currently used for holiday highlighting.
+    # Only useful with generic {Wx::CalendarCtrl} as native versions currently don't support holidays display at all and always return {Wx::NULL_COLOUR}.
+    # @see Wx::CalendarCtrl#set_holiday_colours 
+    # @return [Wx::Colour,String,Symbol]
+    def get_holiday_colour_bg; end
+    alias_method :holiday_colour_bg, :get_holiday_colour_bg
+    
+    # Return the foreground colour currently used for holiday highlighting.
+    # Only useful with generic {Wx::CalendarCtrl} as native versions currently don't support holidays display at all and always return {Wx::NULL_COLOUR}.
+    # @see Wx::CalendarCtrl#set_holiday_colours 
+    # @return [Wx::Colour,String,Symbol]
+    def get_holiday_colour_fg; end
+    alias_method :holiday_colour_fg, :get_holiday_colour_fg
+    
+    # Returns one of {Wx::CalendarHitTestResult} constants and fills either date or wd pointer with the corresponding value depending on the hit test code.
+    # Not implemented in {Wx::GTK} currently.
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param date [Wx::DateTime] 
+    # @param wd [Wx::DateTime::WeekDay] 
+    # @return [CalendarHitTestResult]
+    def hit_test(pos, date=nil, wd=nil) end
+    
+    # Clears any attributes associated with the given day (in the range 1...31).
+    # Only in generic {Wx::CalendarCtrl}.
+    # @param day [Integer] 
+    # @return [void]
+    def reset_attr(day) end
+    
+    # Associates the attribute with the specified date (in the range 1...31).
+    # If the pointer is NULL, the items attribute is cleared. Only in generic {Wx::CalendarCtrl}.
+    # @param day [Integer] 
+    # @param attr [Wx::CalendarDateAttr] 
+    # @return [void]
+    def set_attr(day, attr) end
+    
+    # Sets the current date.
+    # The date parameter must be valid and in the currently valid range as set by {Wx::CalendarCtrl#set_date_range}, otherwise the current date is not changed and the function returns false and, additionally, triggers an assertion failure if the date is invalid.
+    # @param date [Time,Date,DateTime] 
+    # @return [void]
+    def set_date(date) end
+    alias_method :date=, :set_date
+    
+    # Set the colours used for painting the weekdays at the top of the control.
+    # This method is currently only implemented in generic {Wx::CalendarCtrl} and does nothing in the native versions.
+    # @param colFg [Wx::Colour,String,Symbol] 
+    # @param colBg [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_header_colours(colFg, colBg) end
+    
+    # Set the colours to be used for highlighting the currently selected date.
+    # This method is currently only implemented in generic {Wx::CalendarCtrl} and does nothing in the native versions.
+    # @param colFg [Wx::Colour,String,Symbol] 
+    # @param colBg [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_highlight_colours(colFg, colBg) end
+    
+    # Marks the specified day as being a holiday in the current month.
+    # This method is only implemented in the generic version of the control and does nothing in the native ones.
+    # @param day [Integer] 
+    # @return [void]
+    def set_holiday(day) end
+    alias_method :holiday=, :set_holiday
+    
+    # Sets the colours to be used for the holidays highlighting.
+    # This method is only implemented in the generic version of the control and does nothing in the native ones. It should also only be called if the window style includes {Wx::CAL_SHOW_HOLIDAYS} flag or {Wx::CalendarCtrl#enable_holiday_display} had been called.
+    # @param colFg [Wx::Colour,String,Symbol] 
+    # @param colBg [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_holiday_colours(colFg, colBg) end
+    
+    # Mark or unmark the day.
+    # This day of month will be marked in every month. In generic {Wx::CalendarCtrl},
+    # @param day [Integer] 
+    # @param mark [true,false] 
+    # @return [void]
+    def mark(day, mark) end
+    
+  end # CalendarCtrl
+  
+
+end

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

@@ -0,0 +1,137 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::CalendarDateAttr} is a custom attributes for a calendar date.
+  # The objects of this class are used with {Wx::CalendarCtrl}.
+  # === 
+  # 
+  # Category:  Data Structures
+  # @see Wx::CalendarCtrl 
+  # 
+  # 
+  class CalendarDateAttr < ::Object
+  
+    # @overload initialize(colText=Wx::NULL_COLOUR, colBack=Wx::NULL_COLOUR, colBorder=Wx::NULL_COLOUR, font=Wx::NULL_FONT, border=Wx::CAL_BORDER_NONE)
+    #   Constructor for specifying all {Wx::CalendarDateAttr} properties.
+    #   @param colText [Wx::Colour,String,Symbol] 
+    #   @param colBack [Wx::Colour,String,Symbol] 
+    #   @param colBorder [Wx::Colour,String,Symbol] 
+    #   @param font [Wx::Font,Wx::FontInfo] 
+    #   @param border [CalendarDateBorder] 
+    #   @return [CalendarDateAttr]
+    # @overload initialize(border, colBorder=Wx::NULL_COLOUR)
+    #   Constructor using default properties except the given border.
+    #   @param border [CalendarDateBorder] 
+    #   @param colBorder [Wx::Colour,String,Symbol] 
+    #   @return [CalendarDateAttr]
+    def initialize(*args) end
+    
+    # Returns the background colour set for the calendar date.
+    # @return [Wx::Colour,String,Symbol]
+    def get_background_colour; end
+    alias_method :background_colour, :get_background_colour
+    
+    # Returns the border set for the calendar date.
+    # @return [CalendarDateBorder]
+    def get_border; end
+    alias_method :border, :get_border
+    
+    # Returns the border colour set for the calendar date.
+    # @return [Wx::Colour,String,Symbol]
+    def get_border_colour; end
+    alias_method :border_colour, :get_border_colour
+    
+    # Returns the font set for the calendar date.
+    # @return [Wx::Font,Wx::FontInfo]
+    def get_font; end
+    alias_method :font, :get_font
+    
+    # Returns the text colour set for the calendar date.
+    # @return [Wx::Colour,String,Symbol]
+    def get_text_colour; end
+    alias_method :text_colour, :get_text_colour
+    
+    # Returns true if a non-default text background colour is set.
+    # @return [true,false]
+    def has_background_colour; end
+    alias_method :has_background_colour?, :has_background_colour
+    
+    # Returns true if a non-default (i.e. any) border is set.
+    # @return [true,false]
+    def has_border; end
+    alias_method :has_border?, :has_border
+    
+    # Returns true if a non-default border colour is set.
+    # @return [true,false]
+    def has_border_colour; end
+    alias_method :has_border_colour?, :has_border_colour
+    
+    # Returns true if a non-default font is set.
+    # @return [true,false]
+    def has_font; end
+    alias_method :has_font?, :has_font
+    
+    # Returns true if a non-default text foreground colour is set.
+    # @return [true,false]
+    def has_text_colour; end
+    alias_method :has_text_colour?, :has_text_colour
+    
+    # Returns true if this calendar day is displayed as a holiday.
+    # @return [true,false]
+    def is_holiday; end
+    alias_method :holiday?, :is_holiday
+    
+    # Sets the text background colour to use.
+    # @param colBack [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_background_colour(colBack) end
+    alias_method :background_colour=, :set_background_colour
+    
+    # Sets the border to use.
+    # @param border [CalendarDateBorder] 
+    # @return [void]
+    def set_border(border) end
+    alias_method :border=, :set_border
+    
+    # Sets the border colour to use.
+    # @param col [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_border_colour(col) end
+    alias_method :border_colour=, :set_border_colour
+    
+    # Sets the font to use.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_font(font) end
+    alias_method :font=, :set_font
+    
+    # If holiday is true, this calendar day will be displayed as a holiday.
+    # @param holiday [true,false] 
+    # @return [void]
+    def set_holiday(holiday) end
+    alias_method :holiday=, :set_holiday
+    
+    # Sets the text (foreground) colour to use.
+    # @param colText [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_text_colour(colText) end
+    alias_method :text_colour=, :set_text_colour
+    
+    # Used (internally) by the generic {Wx::CalendarCtrl#mark}.
+    # @return [Wx::CalendarDateAttr]
+    def self.get_mark; end
+    
+    # Set the attributes that will be used to Mark() days on the generic {Wx::CalendarCtrl}.
+    # @param m [Wx::CalendarDateAttr] 
+    # @return [void]
+    def self.set_mark(m) end
+    
+  end # CalendarDateAttr
+  
+
+end

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

@@ -0,0 +1,150 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  CAL_SUNDAY_FIRST = 128
+  
+  # 
+  # 
+  CAL_MONDAY_FIRST = 1
+  
+  # 
+  # 
+  CAL_SHOW_HOLIDAYS = 2
+  
+  # 
+  # 
+  CAL_NO_YEAR_CHANGE = 4
+  
+  # 
+  # 
+  CAL_NO_MONTH_CHANGE = 12
+  
+  # 
+  # 
+  CAL_SEQUENTIAL_MONTH_SELECTION = 16
+  
+  # 
+  # 
+  CAL_SHOW_SURROUNDING_WEEKS = 32
+  
+  # 
+  # 
+  CAL_SHOW_WEEK_NUMBERS = 64
+  
+  # Possible kinds of borders which may be used to decorate a date using {Wx::CalendarDateAttr}.
+  # 
+  # 
+  # 
+  class CalendarDateBorder < Wx::Enum
+  
+    # No Border (Default)
+    # 
+    CAL_BORDER_NONE = Wx::CalendarDateBorder.new(0)
+    
+    # Rectangular Border.
+    # 
+    CAL_BORDER_SQUARE = Wx::CalendarDateBorder.new(1)
+    
+    # Round Border.
+    # 
+    CAL_BORDER_ROUND = Wx::CalendarDateBorder.new(2)
+    
+  end # CalendarDateBorder
+  
+  # Possible return values from {Wx::CalendarCtrl#hit_test}.
+  # 
+  # 
+  # 
+  class CalendarHitTestResult < Wx::Enum
+  
+    # Hit outside of anything.
+    # 
+    CAL_HITTEST_NOWHERE = Wx::CalendarHitTestResult.new(0)
+    
+    # Hit on the header (weekdays).
+    # 
+    CAL_HITTEST_HEADER = Wx::CalendarHitTestResult.new(1)
+    
+    # Hit on a day in the calendar.
+    # 
+    CAL_HITTEST_DAY = Wx::CalendarHitTestResult.new(2)
+    
+    # Hit on next month arrow (in alternate month selector mode).
+    # 
+    CAL_HITTEST_INCMONTH = Wx::CalendarHitTestResult.new(3)
+    
+    # Hit on previous month arrow (in alternate month selector mode).
+    # 
+    CAL_HITTEST_DECMONTH = Wx::CalendarHitTestResult.new(4)
+    
+    # Hit on surrounding week of previous/next month (if shown).
+    # 
+    CAL_HITTEST_SURROUNDING_WEEK = Wx::CalendarHitTestResult.new(5)
+    
+    # Hit on week of the year number (if shown).
+    # 
+    CAL_HITTEST_WEEK = Wx::CalendarHitTestResult.new(6)
+    
+  end # CalendarHitTestResult
+  
+  # 
+  # 
+  EVT_CALENDAR_SEL_CHANGED = 10078
+  
+  # 
+  # 
+  EVT_CALENDAR_PAGE_CHANGED = 10079
+  
+  # 
+  # 
+  EVT_CALENDAR_DOUBLECLICKED = 10080
+  
+  # 
+  # 
+  EVT_CALENDAR_WEEKDAY_CLICKED = 10081
+  
+  # 
+  # 
+  EVT_CALENDAR_WEEK_CLICKED = 10082
+  
+  # The {Wx::CalendarEvent} class is used together with {Wx::CalendarCtrl}.
+  # === 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::CalendarCtrl 
+  # 
+  # 
+  class CalendarEvent < DateEvent
+  
+    # @overload initialize()
+    #   @return [CalendarEvent]
+    # @overload initialize(win, dt, type)
+    #   @param win [Wx::Window] 
+    #   @param dt [Time,Date,DateTime] 
+    #   @param type [Integer] 
+    #   @return [CalendarEvent]
+    def initialize(*args) end
+    
+    # Returns the week day on which the user clicked in EVT_CALENDAR_WEEKDAY_CLICKED handler.
+    # It doesn't make sense to call this function in other handlers.
+    # @return [Wx::DateTime::WeekDay]
+    def get_week_day; end
+    alias_method :week_day, :get_week_day
+    
+    # Sets the week day carried by the event, normally only used by the library internally.
+    # @param day [Wx::DateTime::WeekDay] 
+    # @return [void]
+    def set_week_day(day) end
+    alias_method :week_day=, :set_week_day
+    
+  end # CalendarEvent
+  
+
+end

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

@@ -0,0 +1,99 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A caret is a blinking cursor showing the position where the typed text will appear.
+  # Text controls usually have their own caret but {Wx::Caret} provides a way to use a caret in other windows.
+  # Currently, the caret appears as a rectangle of the given size. In the future, it will be possible to specify a bitmap to be used for the caret shape.
+  # A caret is always associated with a window and the current caret can be retrieved using {Wx::Window#get_caret}. The same caret can't be reused in two different windows.
+  # === 
+  # 
+  # Category:  {Wx::Miscellaneous}
+  # 
+  class Caret < ::Object
+  
+    # @overload initialize(window, size)
+    #   Creates a caret with the given size (in pixels) and associates it with the window.
+    #   @param window [Wx::Window] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @return [Caret]
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Caret]
+    def initialize(*args) end
+    
+    # Creates a caret with the given size (in pixels) and associates it with the window (same as the equivalent constructors).
+    # @param window [Wx::Window] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @return [true,false]
+    def create(window, size) end
+    
+    # Get the caret position (in pixels).
+    # <b>{Wx::Perl} Note:</b> In {Wx::Perl} there are two methods instead of a single overloaded method:
+    # - {Wx::Caret#get_position}: returns a Wx::Point object.- GetPositionXY(): returns a 2-element list (x, y).
+    # @return [Wx::Point]
+    def get_position; end
+    alias_method :position, :get_position
+    
+    # Get the caret size.
+    # <b>{Wx::Perl} Note:</b> In {Wx::Perl} there are two methods instead of a single overloaded method:
+    # - {Wx::Caret#get_size}: returns a Wx::Size object.- GetSizeWH(): returns a 2-element list (width, height).
+    # @return [Wx::Size]
+    def get_size; end
+    alias_method :size, :get_size
+    
+    # Move the caret to given position (in logical coordinates).
+    # @param pt [Array(Integer, Integer), Wx::Point] 
+    # @return [void]
+    def move(pt) end
+    
+    # Changes the size of the caret.
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @return [void]
+    def set_size(size) end
+    alias_method :size=, :set_size
+    
+    # Get the window the caret is associated with.
+    # @return [Wx::Window]
+    def get_window; end
+    alias_method :window, :get_window
+    
+    # Hides the caret, same as Show(false).
+    # @return [void]
+    def hide; end
+    
+    # Returns true if the caret was created successfully.
+    # @return [true,false]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Returns true if the caret is visible and false if it is permanently hidden (if it is blinking and not shown currently but will be after the next blink, this method still returns true).
+    # @return [true,false]
+    def is_visible; end
+    alias_method :visible?, :is_visible
+    
+    # Shows or hides the caret.
+    # Notice that if the caret was hidden N times, it must be shown N times as well to reappear on the screen.
+    # @param show [true,false] 
+    # @return [void]
+    def show(show=true) end
+    
+    # Returns the blink time which is measured in milliseconds and is the time elapsed between 2 inversions of the caret (blink time of the caret is the same for all carets, so this functions is static).
+    # @return [Integer]
+    def self.get_blink_time; end
+    
+    # Sets the blink time for all the carets.
+    # Under Windows, this function will change the blink time for all carets permanently (until the next time it is called), even for carets in other applications.
+    # @see Wx::Caret.get_blink_time 
+    # @param milliseconds [Integer] 
+    # @return [void]
+    def self.set_blink_time(milliseconds) end
+    
+  end # Caret
+  
+
+end