# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation
# generator. Do not alter this file.
# :startdoc:
module Wx::PG
#
PG_COLOUR_WEB_BASE = 65536
#
PG_COLOUR_CUSTOM = 16777215
#
PG_COLOUR_UNSPECIFIED = 16777216
#
PG_PROP_TRANSLATE_CUSTOM = 524288
# @return [Wx::String]
def self.pg_get_default_image_wildcard; end
# Base class for custom {Wx::PG::PropertyGrid} editors.
#
>
#
# Category: {Wx::PG::PropertyGrid}
#
# @wxrb_require USE_PROPGRID
class PGEditor < Object
# Constructor.
# @return [Wx::PG::PGEditor]
def initialize; end
# Returns pointer to the name of the editor.
# For example, {Wx::PG_EDITOR_TEXT_CTRL} has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.
# @return [String]
def get_name; end
alias_method :name, :get_name
# Instantiates editor controls.
# >
# @param propgrid [Wx::PG::PropertyGrid] {Wx::PG::PropertyGrid} to which the property belongs (use as parent for control).
# @param property [Wx::PG::PGProperty] Property for which this method is called.
# @param pos [Array(Integer, Integer), Wx::Point] Position, inside {Wx::PG::PropertyGrid}, to create control(s) to.
# @param size [Array(Integer, Integer), Wx::Size] Initial size for control(s).
# @return [Wx::Window,Array]
def create_controls(propgrid, property, pos, size) end
# Loads value from property to the control.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [void]
def update_control(property, ctrl) end
# Draws value for given property.
# @param dc [Wx::DC]
# @param rect [Wx::Rect]
# @param property [Wx::PG::PGProperty]
# @param text [String]
# @return [void]
def draw_value(dc, rect, property, text) end
# Handles events.
# Returns true if value in control was modified (see {Wx::PG::PGProperty#on_event} for more information).
#
# >
# @param propgrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @param wnd_primary [Wx::Window]
# @param event [Wx::Event]
# @return [Boolean]
def on_event(propgrid, property, wnd_primary, event) end
# Returns value from control, via parameter variant.
# Usually ends up calling property's StringToValue() or IntToValue(). Returns true if value was different.
# @param variant [Wx::Variant]
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [Boolean]
def get_value_from_control(variant, property, ctrl) end
alias_method :value_from_control, :get_value_from_control
# Sets value in control to unspecified.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [void]
def set_value_to_unspecified(property, ctrl) end
# Called by property grid to set new appearance for the control.
# Default implementation sets foreground colour, background colour, font, plus text for {Wx::TextCtrl} and {Wx::ComboCtrl}.
# @param pg [Wx::PG::PropertyGrid] Property grid to which the edited property belongs.
# @param property [Wx::PG::PGProperty] Edited property to which the editor control belongs.
# @param ctrl [Wx::Window] Editor control.
# @param appearance [Wx::PG::PGCell] New appearance to be applied.
# @param oldAppearance [Wx::PG::PGCell] Previously applied appearance. Used to detect which control attributes need to be changed (e.g. so we only change background colour if really needed).
# @param unspecified [Boolean] If true tells this function that the new appearance represents an unspecified property value.
# @return [void]
def set_control_appearance(pg, property, ctrl, appearance, oldAppearance, unspecified) end
# Sets control's value specifically from string.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @param txt [String]
# @return [void]
def set_control_string_value(property, ctrl, txt) end
# Sets control's value specifically from int (applies to choice etc.).
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @param value [Integer]
# @return [void]
def set_control_int_value(property, ctrl, value) end
# Inserts item to existing control.
# Index -1 means end of list. Default implementation does nothing. Returns index of item added.
# @param ctrl [Wx::Window]
# @param label [String]
# @param index [Integer]
# @return [Integer]
def insert_item(ctrl, label, index) end
# Deletes item from existing control.
# Default implementation does nothing.
# @param ctrl [Wx::Window]
# @param index [Integer]
# @return [void]
def delete_item(ctrl, index) end
# Extra processing when control gains focus.
# For example, {Wx::TextCtrl} based controls should select all text.
# @param property [Wx::PG::PGProperty]
# @param wnd [Wx::Window]
# @return [void]
def on_focus(property, wnd) end
# Returns true if control itself can contain the custom image.
# Default implementation returns false.
# @return [Boolean]
def can_contain_custom_image; end
alias_method :can_contain_custom_image?, :can_contain_custom_image
end # PGEditor
#
#
#
# @wxrb_require USE_PROPGRID
class PGCheckBoxEditor < PGEditor
# @return [Wx::PG::PGCheckBoxEditor]
def initialize; end
# Returns pointer to the name of the editor.
# For example, {Wx::PG_EDITOR_TEXT_CTRL} has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.
# @return [String]
def get_name; end
alias_method :name, :get_name
# Instantiates editor controls.
# >
# @param propgrid [Wx::PG::PropertyGrid] {Wx::PG::PropertyGrid} to which the property belongs (use as parent for control).
# @param property [Wx::PG::PGProperty] Property for which this method is called.
# @param pos [Array(Integer, Integer), Wx::Point] Position, inside {Wx::PG::PropertyGrid}, to create control(s) to.
# @param size [Array(Integer, Integer), Wx::Size] Initial size for control(s).
# @return [Wx::Window,Array]
def create_controls(propgrid, property, pos, size) end
# Loads value from property to the control.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [void]
def update_control(property, ctrl) end
# Handles events.
# Returns true if value in control was modified (see {Wx::PG::PGProperty#on_event} for more information).
#
# >
# @param propgrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @param wnd_primary [Wx::Window]
# @param event [Wx::Event]
# @return [Boolean]
def on_event(propgrid, property, wnd_primary, event) end
# Returns value from control, via parameter variant.
# Usually ends up calling property's StringToValue() or IntToValue(). Returns true if value was different.
# @param variant [Wx::Variant]
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [Boolean]
def get_value_from_control(variant, property, ctrl) end
alias_method :value_from_control, :get_value_from_control
# Sets value in control to unspecified.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [void]
def set_value_to_unspecified(property, ctrl) end
# Draws value for given property.
# @param dc [Wx::DC]
# @param rect [Wx::Rect]
# @param property [Wx::PG::PGProperty]
# @param text [String]
# @return [void]
def draw_value(dc, rect, property, text) end
# Sets control's value specifically from int (applies to choice etc.).
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @param value [Integer]
# @return [void]
def set_control_int_value(property, ctrl, value) end
end # PGCheckBoxEditor
#
#
#
# @wxrb_require USE_PROPGRID
class PGChoiceEditor < PGEditor
# @return [Wx::PG::PGChoiceEditor]
def initialize; end
# Instantiates editor controls.
# >
# @param propgrid [Wx::PG::PropertyGrid] {Wx::PG::PropertyGrid} to which the property belongs (use as parent for control).
# @param property [Wx::PG::PGProperty] Property for which this method is called.
# @param pos [Array(Integer, Integer), Wx::Point] Position, inside {Wx::PG::PropertyGrid}, to create control(s) to.
# @param size [Array(Integer, Integer), Wx::Size] Initial size for control(s).
# @return [Wx::Window,Array]
def create_controls(propgrid, property, pos, size) end
# Loads value from property to the control.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [void]
def update_control(property, ctrl) end
# Handles events.
# Returns true if value in control was modified (see {Wx::PG::PGProperty#on_event} for more information).
#
# >
# @param propgrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @param wnd_primary [Wx::Window]
# @param event [Wx::Event]
# @return [Boolean]
def on_event(propgrid, property, wnd_primary, event) end
# Returns value from control, via parameter variant.
# Usually ends up calling property's StringToValue() or IntToValue(). Returns true if value was different.
# @param variant [Wx::Variant]
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [Boolean]
def get_value_from_control(variant, property, ctrl) end
alias_method :value_from_control, :get_value_from_control
# Sets value in control to unspecified.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [void]
def set_value_to_unspecified(property, ctrl) end
# Returns pointer to the name of the editor.
# For example, {Wx::PG_EDITOR_TEXT_CTRL} has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.
# @return [String]
def get_name; end
alias_method :name, :get_name
# Sets control's value specifically from int (applies to choice etc.).
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @param value [Integer]
# @return [void]
def set_control_int_value(property, ctrl, value) end
# Sets control's value specifically from string.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @param txt [String]
# @return [void]
def set_control_string_value(property, ctrl, txt) end
# Inserts item to existing control.
# Index -1 means end of list. Default implementation does nothing. Returns index of item added.
# @param ctrl [Wx::Window]
# @param label [String]
# @param index [Integer]
# @return [Integer]
def insert_item(ctrl, label, index) end
# Deletes item from existing control.
# Default implementation does nothing.
# @param ctrl [Wx::Window]
# @param index [Integer]
# @return [void]
def delete_item(ctrl, index) end
# Returns true if control itself can contain the custom image.
# Default implementation returns false.
# @return [Boolean]
def can_contain_custom_image; end
alias_method :can_contain_custom_image?, :can_contain_custom_image
# @param propgrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @param pos [Array(Integer, Integer), Wx::Point]
# @param sz [Array(Integer, Integer), Wx::Size]
# @param extraStyle [Integer]
# @return [Wx::Window]
def create_controls_base(propgrid, property, pos, sz, extraStyle) end
end # PGChoiceEditor
#
#
#
# @wxrb_require USE_PROPGRID
class PGChoiceAndButtonEditor < PGChoiceEditor
# @return [Wx::PG::PGChoiceAndButtonEditor]
def initialize; end
# Returns pointer to the name of the editor.
# For example, {Wx::PG_EDITOR_TEXT_CTRL} has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.
# @return [String]
def get_name; end
alias_method :name, :get_name
# Instantiates editor controls.
# >
# @param propgrid [Wx::PG::PropertyGrid] {Wx::PG::PropertyGrid} to which the property belongs (use as parent for control).
# @param property [Wx::PG::PGProperty] Property for which this method is called.
# @param pos [Array(Integer, Integer), Wx::Point] Position, inside {Wx::PG::PropertyGrid}, to create control(s) to.
# @param size [Array(Integer, Integer), Wx::Size] Initial size for control(s).
# @return [Wx::Window,Array]
def create_controls(propgrid, property, pos, size) end
end # PGChoiceAndButtonEditor
#
#
#
# @wxrb_require USE_PROPGRID
class PGComboBoxEditor < PGChoiceEditor
# @return [Wx::PG::PGComboBoxEditor]
def initialize; end
# Instantiates editor controls.
# >
# @param propgrid [Wx::PG::PropertyGrid] {Wx::PG::PropertyGrid} to which the property belongs (use as parent for control).
# @param property [Wx::PG::PGProperty] Property for which this method is called.
# @param pos [Array(Integer, Integer), Wx::Point] Position, inside {Wx::PG::PropertyGrid}, to create control(s) to.
# @param size [Array(Integer, Integer), Wx::Size] Initial size for control(s).
# @return [Wx::Window,Array]
def create_controls(propgrid, property, pos, size) end
# Returns pointer to the name of the editor.
# For example, {Wx::PG_EDITOR_TEXT_CTRL} has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.
# @return [String]
def get_name; end
alias_method :name, :get_name
# Loads value from property to the control.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [void]
def update_control(property, ctrl) end
# Handles events.
# Returns true if value in control was modified (see {Wx::PG::PGProperty#on_event} for more information).
#
# >
# @param propgrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @param wnd_primary [Wx::Window]
# @param event [Wx::Event]
# @return [Boolean]
def on_event(propgrid, property, wnd_primary, event) end
# Returns value from control, via parameter variant.
# Usually ends up calling property's StringToValue() or IntToValue(). Returns true if value was different.
# @param variant [Wx::Variant]
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [Boolean]
def get_value_from_control(variant, property, ctrl) end
alias_method :value_from_control, :get_value_from_control
# Extra processing when control gains focus.
# For example, {Wx::TextCtrl} based controls should select all text.
# @param property [Wx::PG::PGProperty]
# @param wnd [Wx::Window]
# @return [void]
def on_focus(property, wnd) end
end # PGComboBoxEditor
#
#
#
# @wxrb_require USE_PROPGRID
class PGTextCtrlEditor < PGEditor
# @return [Wx::PG::PGTextCtrlEditor]
def initialize; end
# Instantiates editor controls.
# >
# @param propgrid [Wx::PG::PropertyGrid] {Wx::PG::PropertyGrid} to which the property belongs (use as parent for control).
# @param property [Wx::PG::PGProperty] Property for which this method is called.
# @param pos [Array(Integer, Integer), Wx::Point] Position, inside {Wx::PG::PropertyGrid}, to create control(s) to.
# @param size [Array(Integer, Integer), Wx::Size] Initial size for control(s).
# @return [Wx::Window,Array]
def create_controls(propgrid, property, pos, size) end
# Loads value from property to the control.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [void]
def update_control(property, ctrl) end
# Handles events.
# Returns true if value in control was modified (see {Wx::PG::PGProperty#on_event} for more information).
#
# >
# @param propgrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @param wnd_primary [Wx::Window]
# @param event [Wx::Event]
# @return [Boolean]
def on_event(propgrid, property, wnd_primary, event) end
# Returns value from control, via parameter variant.
# Usually ends up calling property's StringToValue() or IntToValue(). Returns true if value was different.
# @param variant [Wx::Variant]
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [Boolean]
def get_value_from_control(variant, property, ctrl) end
alias_method :value_from_control, :get_value_from_control
# Returns pointer to the name of the editor.
# For example, {Wx::PG_EDITOR_TEXT_CTRL} has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.
# @return [String]
def get_name; end
alias_method :name, :get_name
# Sets control's value specifically from string.
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @param txt [String]
# @return [void]
def set_control_string_value(property, ctrl, txt) end
# Extra processing when control gains focus.
# For example, {Wx::TextCtrl} based controls should select all text.
# @param property [Wx::PG::PGProperty]
# @param wnd [Wx::Window]
# @return [void]
def on_focus(property, wnd) end
# @param propgrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @param event [Wx::Event]
# @return [Boolean]
def self.on_text_ctrl_event(propgrid, property, ctrl, event) end
# @param variant [Wx::Variant]
# @param property [Wx::PG::PGProperty]
# @param ctrl [Wx::Window]
# @return [Boolean]
def self.get_text_ctrl_value_from_control(variant, property, ctrl) end
end # PGTextCtrlEditor
#
#
#
# @wxrb_require USE_PROPGRID
class PGSpinCtrlEditor < PGTextCtrlEditor
# Returns pointer to the name of the editor.
# For example, {Wx::PG_EDITOR_TEXT_CTRL} has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.
# @return [String]
def get_name; end
alias_method :name, :get_name
# Instantiates editor controls.
# >
# @param propgrid [Wx::PG::PropertyGrid] {Wx::PG::PropertyGrid} to which the property belongs (use as parent for control).
# @param property [Wx::PG::PGProperty] Property for which this method is called.
# @param pos [Array(Integer, Integer), Wx::Point] Position, inside {Wx::PG::PropertyGrid}, to create control(s) to.
# @param size [Array(Integer, Integer), Wx::Size] Initial size for control(s).
# @return [Wx::Window,Array]
def create_controls(propgrid, property, pos, size) end
# Handles events.
# Returns true if value in control was modified (see {Wx::PG::PGProperty#on_event} for more information).
#
# >
# @param propgrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @param wnd_primary [Wx::Window]
# @param event [Wx::Event]
# @return [Boolean]
def on_event(propgrid, property, wnd_primary, event) end
end # PGSpinCtrlEditor
#
#
#
# @wxrb_require USE_PROPGRID
class PGTextCtrlAndButtonEditor < PGTextCtrlEditor
# @return [Wx::PG::PGTextCtrlAndButtonEditor]
def initialize; end
# Returns pointer to the name of the editor.
# For example, {Wx::PG_EDITOR_TEXT_CTRL} has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.
# @return [String]
def get_name; end
alias_method :name, :get_name
# Instantiates editor controls.
# >
# @param propgrid [Wx::PG::PropertyGrid] {Wx::PG::PropertyGrid} to which the property belongs (use as parent for control).
# @param property [Wx::PG::PGProperty] Property for which this method is called.
# @param pos [Array(Integer, Integer), Wx::Point] Position, inside {Wx::PG::PropertyGrid}, to create control(s) to.
# @param size [Array(Integer, Integer), Wx::Size] Initial size for control(s).
# @return [Wx::Window,Array]
def create_controls(propgrid, property, pos, size) end
end # PGTextCtrlAndButtonEditor
# Derive a class from this to adapt an existing editor dialog or function to be used when editor button of a property is pushed.
# You only need to derive class and implement {Wx::PG::PGEditorDialogAdapter#do_show_dialog} to create and show the dialog, and finally submit the value returned by the dialog via {Wx::PG::PGEditorDialogAdapter#set_value}.
#
# Category: {Wx::PG::PropertyGrid}
#
# @wxrb_require USE_PROPGRID
class PGEditorDialogAdapter < Object
# @return [Wx::PG::PGEditorDialogAdapter]
def initialize; end
# @param propGrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @return [Boolean]
def show_dialog(propGrid, property) end
# @param propGrid [Wx::PG::PropertyGrid]
# @param property [Wx::PG::PGProperty]
# @return [Boolean]
def do_show_dialog(propGrid, property) end
# @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array,Array,ObjectWx::PG::ColourPropertyValue]
# @return [void]
def set_value(value) end
alias_method :value=, :set_value
# This method is typically only used if deriving class from existing adapter with value conversion purposes.
# @return [Wx::Variant]
def get_value; end
alias_method :value, :get_value
end # PGEditorDialogAdapter
end