wxruby3 0.9.3-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/ext/wxbase32u_gcc_custom.dll +0 -0
- data/ext/wxbase32u_net_gcc_custom.dll +0 -0
- data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
- data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
- data/lib/wx/core/book_ctrl_base.rb +16 -0
- data/lib/wx/core/config.rb +454 -83
- data/lib/wx/core/notebook.rb +10 -8
- data/lib/wx/core/peristent_object.rb +15 -0
- data/lib/wx/core/persistence_manager.rb +39 -0
- data/lib/wx/core/persistent_window.rb +16 -0
- data/lib/wx/core/top_level_window.rb +16 -0
- data/lib/wx/core/treebook.rb +18 -0
- data/lib/wx/core.rb +4 -0
- data/lib/wx/doc/book_ctrl_base.rb +19 -0
- data/lib/wx/doc/config.rb +101 -41
- data/lib/wx/doc/extra/14_config.md +101 -0
- data/lib/wx/doc/extra/15_persistence.md +148 -0
- data/lib/wx/doc/gen/aui/aui_manager_event.rb +1 -1
- data/lib/wx/doc/gen/aui/aui_notebook_event.rb +1 -1
- data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +1 -1
- data/lib/wx/doc/gen/book_ctrl_event.rb +1 -1
- data/lib/wx/doc/gen/calendar_event.rb +1 -1
- data/lib/wx/doc/gen/core.rb +2 -2
- data/lib/wx/doc/gen/date_event.rb +1 -1
- data/lib/wx/doc/gen/event.rb +4 -4
- data/lib/wx/doc/gen/event_blocker.rb +1 -1
- data/lib/wx/doc/gen/event_filter.rb +0 -2
- data/lib/wx/doc/gen/events.rb +15 -15
- data/lib/wx/doc/gen/file_ctrl_event.rb +1 -1
- data/lib/wx/doc/gen/file_dialog_customize_hook.rb +2 -2
- data/lib/wx/doc/gen/file_dir_picker_event.rb +1 -1
- data/lib/wx/doc/gen/find_dialog_event.rb +1 -1
- data/lib/wx/doc/gen/gdi_common.rb +0 -8
- data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_attr.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +0 -2
- data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_event.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_range_select_event.rb +1 -1
- data/lib/wx/doc/gen/grid/grid_size_event.rb +1 -1
- data/lib/wx/doc/gen/gui_event_loop.rb +0 -2
- data/lib/wx/doc/gen/header_ctrl.rb +0 -6
- data/lib/wx/doc/gen/header_ctrl_event.rb +1 -1
- data/lib/wx/doc/gen/html/html_cell_event.rb +1 -1
- data/lib/wx/doc/gen/list_event.rb +1 -1
- data/lib/wx/doc/gen/media_event.rb +1 -1
- data/lib/wx/doc/gen/persistence_manager.rb +135 -0
- data/lib/wx/doc/gen/persistent_object.rb +52 -0
- data/lib/wx/doc/gen/persistent_window.rb +116 -0
- data/lib/wx/doc/gen/pg/property_grid_event.rb +1 -1
- data/lib/wx/doc/gen/pg/property_grid_interface.rb +2 -2
- data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +1 -1
- data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +1 -1
- data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +1 -1
- data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +1 -1
- data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +1 -1
- data/lib/wx/doc/gen/rtc/rich_text_event.rb +1 -1
- data/lib/wx/doc/gen/spin_double_event.rb +1 -1
- data/lib/wx/doc/gen/spin_event.rb +1 -1
- data/lib/wx/doc/gen/splitter_event.rb +1 -1
- data/lib/wx/doc/gen/stc/styled_text_event.rb +1 -1
- data/lib/wx/doc/gen/task_bar_icon_event.rb +1 -1
- data/lib/wx/doc/gen/text_entry.rb +0 -4
- data/lib/wx/doc/gen/tree_event.rb +1 -1
- data/lib/wx/doc/gen/utils.rb +0 -16
- data/lib/wx/doc/gen/wizard_event.rb +1 -1
- data/lib/wx/doc/persistence_manager.rb +36 -0
- data/lib/wx/doc/persistent_object.rb +27 -0
- data/lib/wx/doc/top_level_window.rb +19 -0
- data/lib/wx/doc/treebook.rb +6 -1
- data/lib/wx/version.rb +1 -1
- data/lib/wxruby_aui.so +0 -0
- data/lib/wxruby_core.so +0 -0
- data/lib/wxruby_grid.so +0 -0
- data/lib/wxruby_html.so +0 -0
- data/lib/wxruby_pg.so +0 -0
- data/lib/wxruby_prt.so +0 -0
- data/lib/wxruby_rbn.so +0 -0
- data/lib/wxruby_rtc.so +0 -0
- data/lib/wxruby_stc.so +0 -0
- data/samples/widgets/widgets.rb +5 -9
- data/tests/test_config.rb +207 -42
- data/tests/test_persistence.rb +142 -0
- metadata +18 -2
@@ -0,0 +1,135 @@
|
|
1
|
+
# :stopdoc:
|
2
|
+
# This file is automatically generated by the WXRuby3 documentation
|
3
|
+
# generator. Do not alter this file.
|
4
|
+
# :startdoc:
|
5
|
+
|
6
|
+
|
7
|
+
module Wx
|
8
|
+
|
9
|
+
# Provides support for automatically saving and restoring object properties to persistent storage.
|
10
|
+
#
|
11
|
+
# This class is the central element of wxWidgets persistence framework, see Persistent Objects Overview for its overview.
|
12
|
+
# This is a singleton class and its unique instance can be retrieved using {Wx::PersistenceManager.get} method.
|
13
|
+
#
|
14
|
+
# @wxrb_require USE_CONFIG
|
15
|
+
class PersistenceManager < ::Object
|
16
|
+
|
17
|
+
# @overload register_and_restore(obj)
|
18
|
+
# Combines both {Wx::PersistenceManager#register} and {Wx::PersistenceManager#restore} calls.
|
19
|
+
# @param obj [Object]
|
20
|
+
# @return [Boolean]
|
21
|
+
# @overload register_and_restore(obj, po)
|
22
|
+
# Combines both {Wx::PersistenceManager#register} and {Wx::PersistenceManager#restore} calls.
|
23
|
+
# @param obj [Object]
|
24
|
+
# @param po [Wx::PersistentObject]
|
25
|
+
# @return [Boolean]
|
26
|
+
def register_and_restore(*args) end
|
27
|
+
|
28
|
+
# Set the global persistence manager to use.
|
29
|
+
#
|
30
|
+
# Call this method to specify a non-default persistence manager to use. It should usually be called very early (e.g. in {Wx::App}-derived class constructor or in the beginning of overridden {Wx::App#on_init}) to affect creation of all persistent controls and the object passed to it must have a lifetime long enough to be still alive when the persistent controls are destroyed and need it to save their state so typically this would be a global or a {Wx::App} member.
|
31
|
+
# @param manager [Wx::PersistenceManager]
|
32
|
+
# @return [void]
|
33
|
+
def self.set(manager) end
|
34
|
+
|
35
|
+
# Returns the unique persistence manager object.
|
36
|
+
#
|
37
|
+
# If {Wx::PersistenceManager.set} hadn't been called before, a default persistence manager implementation is returned.
|
38
|
+
# @return [Wx::PersistenceManager]
|
39
|
+
def self.get; end
|
40
|
+
|
41
|
+
# Globally disable saving the persistence object properties.
|
42
|
+
#
|
43
|
+
# By default, saving properties in {Wx::PersistenceManager#save} is enabled but the program may wish to disable if, for example, it detects that it is running on a system which shouldn't be modified in any way and so configuration file (or Windows registry) shouldn't be written to.
|
44
|
+
# @see Wx::PersistenceManager#disable_restoring
|
45
|
+
# @return [void]
|
46
|
+
def disable_saving; end
|
47
|
+
|
48
|
+
# Globally disable restoring the persistence object properties.
|
49
|
+
#
|
50
|
+
# By default, restoring properties in {Wx::PersistenceManager#restore} is enabled but this function allows disabling it. This is mostly useful for testing.
|
51
|
+
# @see Wx::PersistenceManager#disable_saving
|
52
|
+
# @return [void]
|
53
|
+
def disable_restoring; end
|
54
|
+
|
55
|
+
# @overload register(obj)
|
56
|
+
# Register an object with the manager automatically creating a persistence adapter for it.
|
57
|
+
#
|
58
|
+
# This is equivalent to calling Register(void *, wxPersistentObject *) with {create_persistent_object(obj)} as the second argument.
|
59
|
+
# @param obj [Object] The object to register. {create_persistent_object} overload must be defined for the objects of this class.
|
60
|
+
# @return [Wx::PersistentObject]
|
61
|
+
# @overload register(obj, po)
|
62
|
+
# Register an object with the manager.
|
63
|
+
#
|
64
|
+
# Note that registering the object doesn't do anything except allowing to call {Wx::PersistenceManager#restore} for it later. If you want to register the object and restore its properties, use {Wx::PersistenceManager#register_and_restore}.
|
65
|
+
# The manager takes ownership of po and will delete it when it is unregistered.
|
66
|
+
# @param obj [Object] The object to register.
|
67
|
+
# @param po [Wx::PersistentObject] The {Wx::PersistentObject} to use for saving and restoring this object properties.
|
68
|
+
# @return [Wx::PersistentObject]
|
69
|
+
def register(*args) end
|
70
|
+
|
71
|
+
# Check if the object is registered and return the associated {Wx::PersistentObject} if it is or NULL otherwise.
|
72
|
+
# @param obj [Object]
|
73
|
+
# @return [Wx::PersistentObject]
|
74
|
+
def find(obj) end
|
75
|
+
|
76
|
+
# Unregister the object and delete the associated {Wx::PersistentObject}.
|
77
|
+
#
|
78
|
+
# For the persistent windows this is done automatically (via {Wx::PersistenceManager#save_and_unregister}) when the window is destroyed so you only need to call this function explicitly if you are using custom persistent objects or if you want to prevent the object properties from being saved.
|
79
|
+
# @param obj [Object] An object previously registered with {Wx::PersistenceManager#register}.
|
80
|
+
# @return [void]
|
81
|
+
def unregister(obj) end
|
82
|
+
|
83
|
+
# Save the object properties to persistent storage.
|
84
|
+
#
|
85
|
+
# This method does nothing if {Wx::PersistenceManager#disable_saving} had been called.
|
86
|
+
# @see Wx::PersistenceManager#save_and_unregister
|
87
|
+
# @param obj [Object] An object previously registered with {Wx::PersistenceManager#register}.
|
88
|
+
# @return [void]
|
89
|
+
def save(obj) end
|
90
|
+
|
91
|
+
# Restore the object properties previously saved by {Wx::PersistenceManager#save}.
|
92
|
+
#
|
93
|
+
# This method does nothing if {Wx::PersistenceManager#disable_restoring} had been called.
|
94
|
+
#
|
95
|
+
# true if the object properties were restored or false if nothing was found to restore or the saved settings were invalid.
|
96
|
+
# @see Wx::PersistenceManager#register_and_restore
|
97
|
+
# @param obj [Object] An object previously registered with {Wx::PersistenceManager#register}.
|
98
|
+
# @return [Boolean]
|
99
|
+
def restore(obj) end
|
100
|
+
|
101
|
+
# Combines both {Wx::PersistenceManager#save} and {Wx::PersistenceManager#unregister} calls.
|
102
|
+
# @param obj [Object]
|
103
|
+
# @return [void]
|
104
|
+
def save_and_unregister(obj) end
|
105
|
+
|
106
|
+
|
107
|
+
protected
|
108
|
+
|
109
|
+
# Protected default constructor.
|
110
|
+
#
|
111
|
+
# This constructor is only provided for the derived classes, to use an object of this class static {Wx::PersistenceManager.get} method should be called.
|
112
|
+
# @return [Wx::PersistenceManager]
|
113
|
+
def initialize; end
|
114
|
+
|
115
|
+
# Return the config object to use.
|
116
|
+
#
|
117
|
+
# By default the global {Wx::Config}, returned by {Wx::ConfigBase#get}, is used but a derived class could override this function to return a different one if necessary.
|
118
|
+
# @return [Wx::ConfigBase]
|
119
|
+
def get_config; end
|
120
|
+
alias_method :config, :get_config
|
121
|
+
|
122
|
+
# Return the path to use for saving the setting with the given name for the specified object.
|
123
|
+
#
|
124
|
+
# Notice that the name argument is the name of the setting, not the name of the object itself which can be retrieved with its GetName() method.
|
125
|
+
# This method can be overridden by a derived class to change where in {Wx::Config} the different options are stored. By default, all settings of the persistent controls are stored under "Persistent_Options" group and grouped by control type (e.g. "Window" for top level windows or "Splitter") and name, so that the position of a splitter called "sep" could be stored under "Persistent_Options/Splitter/sep/Position" key.
|
126
|
+
# @param who [Wx::PersistentObject]
|
127
|
+
# @param name [String]
|
128
|
+
# @return [String]
|
129
|
+
def get_key(who, name) end
|
130
|
+
alias_method :key, :get_key
|
131
|
+
|
132
|
+
end # PersistenceManager
|
133
|
+
|
134
|
+
|
135
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# :stopdoc:
|
2
|
+
# This file is automatically generated by the WXRuby3 documentation
|
3
|
+
# generator. Do not alter this file.
|
4
|
+
# :startdoc:
|
5
|
+
|
6
|
+
|
7
|
+
module Wx
|
8
|
+
|
9
|
+
# Base class for persistent object adapters.
|
10
|
+
#
|
11
|
+
# See Persistent Objects Overview for an overview of persistent objects within wxWidgets.
|
12
|
+
# wxWidgets persistence framework is non-intrusive, i.e. can work with the classes which have no relationship to nor knowledge of it. To allow this, an intermediate persistence adapter is used: this is just a simple object which provides the methods used by {Wx::PersistenceManager} to save and restore the object properties and implements them using the concrete class methods.
|
13
|
+
# You may derive your own classes from {Wx::PersistentObject} to implement persistence support for your common classes, see Defining Custom Persistent Windows.
|
14
|
+
# @see wxPersistentWindow<>
|
15
|
+
#
|
16
|
+
#
|
17
|
+
# @wxrb_require USE_CONFIG
|
18
|
+
class PersistentObject < ::Object
|
19
|
+
|
20
|
+
# Save the object properties.
|
21
|
+
#
|
22
|
+
# The implementation of this method should use {Wx::PersistentObject#save_value}.
|
23
|
+
# @return [void]
|
24
|
+
def save; end
|
25
|
+
|
26
|
+
# Restore the object properties.
|
27
|
+
#
|
28
|
+
# The implementation of this method should use {Wx::PersistentObject#restore_value}.
|
29
|
+
# @return [Boolean]
|
30
|
+
def restore; end
|
31
|
+
|
32
|
+
# Returns the string uniquely identifying the objects supported by this adapter.
|
33
|
+
#
|
34
|
+
# This method is called from {Wx::PersistentObject#save_value} and {Wx::PersistentObject#restore_value} and normally returns some short (but not too cryptic) strings, e.g. <code>"Checkbox"</code>.
|
35
|
+
# @return [String]
|
36
|
+
def get_kind; end
|
37
|
+
alias_method :kind, :get_kind
|
38
|
+
|
39
|
+
# Returns the string uniquely identifying the object we're associated with among all the other objects of the same type.
|
40
|
+
#
|
41
|
+
# This method is used together with {Wx::PersistentObject#get_kind} to construct the unique full name of the object in e.g. a configuration file.
|
42
|
+
# @return [String]
|
43
|
+
def get_name; end
|
44
|
+
alias_method :name, :get_name
|
45
|
+
|
46
|
+
|
47
|
+
protected
|
48
|
+
|
49
|
+
end # PersistentObject
|
50
|
+
|
51
|
+
|
52
|
+
end
|
@@ -0,0 +1,116 @@
|
|
1
|
+
# :stopdoc:
|
2
|
+
# This file is automatically generated by the WXRuby3 documentation
|
3
|
+
# generator. Do not alter this file.
|
4
|
+
# :startdoc:
|
5
|
+
|
6
|
+
|
7
|
+
module Wx
|
8
|
+
|
9
|
+
# Base class for persistent windows.
|
10
|
+
#
|
11
|
+
# Compared to {Wx::PersistentObject} this class does three things:
|
12
|
+
#
|
13
|
+
# - Most importantly, {Wx::PersistentWindow} catches {Wx::WindowDestroyEvent} generated when the window is destroyed and saves its properties automatically when it happens.
|
14
|
+
# - It implements {Wx::PersistentWindow#get_name} using {Wx::Window#get_name} so that the derived classes don't need to do it.
|
15
|
+
# - It adds a convenient {Wx::PersistentWindow#get} accessor returning the window object of the correct type.
|
16
|
+
#
|
17
|
+
# @wxrb_require USE_CONFIG
|
18
|
+
class PersistentWindowBase < PersistentObject
|
19
|
+
|
20
|
+
# Constructor for a persistent window object.
|
21
|
+
#
|
22
|
+
# The constructor uses {Wx::EvtHandler#bind} to catch {Wx::WindowDestroyEvent} generated when the window is destroyed and call {Wx::PersistenceManager#save_and_unregister} when this happens. This ensures that the window properties are saved and that this object itself is deleted when the window is.
|
23
|
+
# @param win [Wx::Window]
|
24
|
+
# @return [Wx::PersistentWindowBase]
|
25
|
+
def initialize(win) end
|
26
|
+
|
27
|
+
# @return [Wx::Window]
|
28
|
+
def get; end
|
29
|
+
|
30
|
+
# Implements the base class pure virtual method using {Wx::Window#get_name}.
|
31
|
+
#
|
32
|
+
# Notice that window names are usually not unique while this function must return a unique (at least among the objects of this type) string. Because of this you need to specify a non-default window name in its constructor when creating it or explicitly call {Wx::Window#set_name} before saving or restoring persistent properties.
|
33
|
+
# @return [String]
|
34
|
+
def get_name; end
|
35
|
+
alias_method :name, :get_name
|
36
|
+
|
37
|
+
|
38
|
+
protected
|
39
|
+
|
40
|
+
end # PersistentWindowBase
|
41
|
+
|
42
|
+
# Persistence adapter for {Wx::TopLevelWindow}.
|
43
|
+
#
|
44
|
+
# This adapter saves and restores the geometry (i.e. position and size) and the state (iconized, maximized or normal) of top level windows. It can be used with both {Wx::Frame} and {Wx::Dialog}.
|
45
|
+
# Note that it does not save nor restore the window visibility.
|
46
|
+
#
|
47
|
+
# @wxrb_require USE_CONFIG
|
48
|
+
class PersistentTLW < PersistentWindow
|
49
|
+
|
50
|
+
# Constructor.
|
51
|
+
# @param book [Wx::TopLevelWindow] The associated window.
|
52
|
+
# @return [Wx::PersistentTLW]
|
53
|
+
def initialize(book) end
|
54
|
+
|
55
|
+
# Save the current window geometry.
|
56
|
+
# @return [void]
|
57
|
+
def save; end
|
58
|
+
|
59
|
+
# Restore the window geometry.
|
60
|
+
# @return [Boolean]
|
61
|
+
def restore; end
|
62
|
+
|
63
|
+
end # PersistentTLW
|
64
|
+
|
65
|
+
# Persistence adapter for {Wx::BookCtrlBase}.
|
66
|
+
#
|
67
|
+
# This adapter handles the selected page of {Wx::BookCtrlBase}, i.e. it saves its value when the associated book control is destroyed and restores it when it is recreated.
|
68
|
+
# @see Wx::PersistentTreeBookCtrl
|
69
|
+
#
|
70
|
+
#
|
71
|
+
# @wxrb_require USE_CONFIG
|
72
|
+
class PersistentBookCtrl < PersistentWindow
|
73
|
+
|
74
|
+
# Constructor.
|
75
|
+
# @param book [Wx::BookCtrlBase] The associated book control.
|
76
|
+
# @return [Wx::PersistentBookCtrl]
|
77
|
+
def initialize(book) end
|
78
|
+
|
79
|
+
# Save the currently selected page index.
|
80
|
+
# @return [void]
|
81
|
+
def save; end
|
82
|
+
|
83
|
+
# Restore the selected page index.
|
84
|
+
#
|
85
|
+
# The book control must be initialized before calling this function, i.e. all of its pages should be already added to it otherwise restoring the selection has no effect.
|
86
|
+
# @return [Boolean]
|
87
|
+
def restore; end
|
88
|
+
|
89
|
+
end # PersistentBookCtrl
|
90
|
+
|
91
|
+
# Persistence adapter for {Wx::Treebook}.
|
92
|
+
#
|
93
|
+
# This adapter saves and restores the expanded branches of the {Wx::TreeCtrl} used by {Wx::Treebook}, in addition to saving and restoring the selection as implemented by the base {Wx::PersistentBookCtrl} class.
|
94
|
+
#
|
95
|
+
# @wxrb_require USE_CONFIG
|
96
|
+
class PersistentTreeBookCtrl < PersistentBookCtrl
|
97
|
+
|
98
|
+
# Constructor.
|
99
|
+
# @param book [Wx::Treebook] The associated tree book control.
|
100
|
+
# @return [Wx::PersistentTreeBookCtrl]
|
101
|
+
def initialize(book) end
|
102
|
+
|
103
|
+
# Save the currently opened branches.
|
104
|
+
# @return [void]
|
105
|
+
def save; end
|
106
|
+
|
107
|
+
# Restore the opened branches.
|
108
|
+
#
|
109
|
+
# The book control must be initialized before calling this function, i.e. all of its pages should be already added to it.
|
110
|
+
# @return [Boolean]
|
111
|
+
def restore; end
|
112
|
+
|
113
|
+
end # PersistentTreeBookCtrl
|
114
|
+
|
115
|
+
|
116
|
+
end
|
@@ -47,7 +47,7 @@ module Wx::PG
|
|
47
47
|
|
48
48
|
# @overload initialize(commandType=0, id=0)
|
49
49
|
# Constructor.
|
50
|
-
# @param commandType [Wx::
|
50
|
+
# @param commandType [Wx::Notebook::EventType]
|
51
51
|
# @param id [Integer]
|
52
52
|
# @return [Wx::PG::PropertyGridEvent]
|
53
53
|
# @overload initialize(event)
|
@@ -655,12 +655,12 @@ module Wx::PG
|
|
655
655
|
# @param src [String] String generated by SaveEditableState.
|
656
656
|
# @param restoreStates [Integer] Which parts to restore from source string. See list of editable state flags.
|
657
657
|
# @return [Boolean]
|
658
|
-
def restore_editable_state(src, restoreStates=Wx::PG::
|
658
|
+
def restore_editable_state(src, restoreStates=Wx::PG::PropertyGrid::EditableStateFlags::AllStates) end
|
659
659
|
|
660
660
|
# Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions).
|
661
661
|
# @param includedStates [Integer] Which parts of state to include. See list of editable state flags.
|
662
662
|
# @return [String]
|
663
|
-
def save_editable_state(includedStates=Wx::PG::
|
663
|
+
def save_editable_state(includedStates=Wx::PG::PropertyGrid::EditableStateFlags::AllStates) end
|
664
664
|
|
665
665
|
# Set proportion of an auto-stretchable column.
|
666
666
|
#
|
@@ -18,7 +18,7 @@ module Wx::RBN
|
|
18
18
|
class RibbonBarEvent < NotifyEvent
|
19
19
|
|
20
20
|
# Constructor.
|
21
|
-
# @param command_type [Wx::
|
21
|
+
# @param command_type [Wx::Notebook::EventType]
|
22
22
|
# @param win_id [Integer]
|
23
23
|
# @param page [Wx::RBN::RibbonPage]
|
24
24
|
# @return [Wx::RBN::RibbonBarEvent]
|
@@ -19,7 +19,7 @@ module Wx::RBN
|
|
19
19
|
class RibbonButtonBarEvent < CommandEvent
|
20
20
|
|
21
21
|
# Constructor.
|
22
|
-
# @param command_type [Wx::
|
22
|
+
# @param command_type [Wx::Notebook::EventType]
|
23
23
|
# @param win_id [Integer]
|
24
24
|
# @param bar [Wx::RBN::RibbonButtonBar]
|
25
25
|
# @param button [Integer]
|
@@ -16,7 +16,7 @@ module Wx::RBN
|
|
16
16
|
class RibbonGalleryEvent < CommandEvent
|
17
17
|
|
18
18
|
# Constructor.
|
19
|
-
# @param command_type [Wx::
|
19
|
+
# @param command_type [Wx::Notebook::EventType]
|
20
20
|
# @param win_id [Integer]
|
21
21
|
# @param gallery [Wx::RBN::RibbonGallery]
|
22
22
|
# @param item [Integer]
|
@@ -18,7 +18,7 @@ module Wx::RBN
|
|
18
18
|
class RibbonPanelEvent < CommandEvent
|
19
19
|
|
20
20
|
# Constructor.
|
21
|
-
# @param command_type [Wx::
|
21
|
+
# @param command_type [Wx::Notebook::EventType]
|
22
22
|
# @param win_id [Integer]
|
23
23
|
# @param panel [Wx::RBN::RibbonPanel]
|
24
24
|
# @return [Wx::RBN::RibbonPanelEvent]
|
@@ -13,7 +13,7 @@ module Wx::RBN
|
|
13
13
|
# @wxrb_require USE_RIBBON
|
14
14
|
class RibbonToolBarEvent < CommandEvent
|
15
15
|
|
16
|
-
# @param command_type [Wx::
|
16
|
+
# @param command_type [Wx::Notebook::EventType]
|
17
17
|
# @param win_id [Integer]
|
18
18
|
# @param bar [Wx::RBN::RibbonToolBar]
|
19
19
|
# @return [Wx::RBN::RibbonToolBarEvent]
|
@@ -58,7 +58,7 @@ module Wx::RTC
|
|
58
58
|
|
59
59
|
# @overload initialize(commandType=Wx::EVT_NULL, winid=0)
|
60
60
|
# Constructor.
|
61
|
-
# @param commandType [Wx::
|
61
|
+
# @param commandType [Wx::Notebook::EventType] The type of the event.
|
62
62
|
# @param winid [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
|
63
63
|
# @return [Wx::RTC::RichTextEvent]
|
64
64
|
# @overload initialize(event)
|
@@ -26,7 +26,7 @@ module Wx
|
|
26
26
|
# The constructor.
|
27
27
|
#
|
28
28
|
# Not normally used by the user code.
|
29
|
-
# @param commandType [Wx::
|
29
|
+
# @param commandType [Wx::Notebook::EventType]
|
30
30
|
# @param winid [Integer]
|
31
31
|
# @param value [Float]
|
32
32
|
# @return [Wx::SpinDoubleEvent]
|
@@ -29,7 +29,7 @@ module Wx
|
|
29
29
|
class SpinEvent < NotifyEvent
|
30
30
|
|
31
31
|
# The constructor is not normally used by the user code.
|
32
|
-
# @param commandType [Wx::
|
32
|
+
# @param commandType [Wx::Notebook::EventType]
|
33
33
|
# @param id [Integer]
|
34
34
|
# @return [Wx::SpinEvent]
|
35
35
|
def initialize(commandType=Wx::EVT_NULL, id=0) end
|
@@ -33,7 +33,7 @@ module Wx
|
|
33
33
|
# Constructor.
|
34
34
|
#
|
35
35
|
# Used internally by wxWidgets only.
|
36
|
-
# @param eventType [Wx::
|
36
|
+
# @param eventType [Wx::Notebook::EventType]
|
37
37
|
# @param splitter [Wx::SplitterWindow]
|
38
38
|
# @return [Wx::SplitterEvent]
|
39
39
|
def initialize(eventType=Wx::EVT_NULL, splitter=nil) end
|
@@ -7064,7 +7064,7 @@ module Wx::STC
|
|
7064
7064
|
|
7065
7065
|
# @overload initialize(commandType=0, id=0)
|
7066
7066
|
# Constructor.
|
7067
|
-
# @param commandType [Wx::
|
7067
|
+
# @param commandType [Wx::Notebook::EventType]
|
7068
7068
|
# @param id [Integer]
|
7069
7069
|
# @return [Wx::STC::StyledTextEvent]
|
7070
7070
|
# @overload initialize(event)
|
@@ -77,7 +77,7 @@ module Wx
|
|
77
77
|
class TaskBarIconEvent < Event
|
78
78
|
|
79
79
|
# Constructor.
|
80
|
-
# @param evtType [Wx::
|
80
|
+
# @param evtType [Wx::Notebook::EventType]
|
81
81
|
# @param tbIcon [Wx::TaskBarIcon]
|
82
82
|
# @return [Wx::TaskBarIconEvent]
|
83
83
|
def initialize(evtType, tbIcon) end
|
@@ -371,8 +371,6 @@ module Wx
|
|
371
371
|
# Custom completer objects used with {Wx::TextEntry#auto_complete} must derive from this class and implement its pure virtual method returning the completions. You would typically use a custom completer when the total number of completions is too big for performance to be acceptable if all of them need to be returned at once but if they can be generated hierarchically, i.e. only the first component initially, then the second one after the user finished entering the first one and so on.
|
372
372
|
# When inheriting from this class you need to implement its two pure virtual methods. This allows returning the results incrementally and may or not be convenient depending on where do they come from. If you prefer to return all the completions at once, you should inherit from {Wx::TextCompleterSimple} instead.
|
373
373
|
#
|
374
|
-
#
|
375
|
-
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
376
374
|
class TextCompleter < ::Object
|
377
375
|
|
378
376
|
# Function called to start iteration over the completions for the given prefix.
|
@@ -420,8 +418,6 @@ module Wx
|
|
420
418
|
# text_ctrl.auto_complete(MyTextCompleter.new)
|
421
419
|
# ```
|
422
420
|
#
|
423
|
-
#
|
424
|
-
# @note This class is <b>untracked</b> and should not be derived from nor instances extended!
|
425
421
|
class TextCompleterSimple < TextCompleter
|
426
422
|
|
427
423
|
# Pure virtual method returning all possible completions for the given prefix.
|
@@ -64,7 +64,7 @@ module Wx
|
|
64
64
|
class TreeEvent < NotifyEvent
|
65
65
|
|
66
66
|
# Constructor, used by wxWidgets itself only.
|
67
|
-
# @param commandType [Wx::
|
67
|
+
# @param commandType [Wx::Notebook::EventType]
|
68
68
|
# @param tree [Wx::TreeCtrl]
|
69
69
|
# @param item [Wx::TreeItemId]
|
70
70
|
# @return [Wx::TreeEvent]
|
data/lib/wx/doc/gen/utils.rb
CHANGED
@@ -57,8 +57,6 @@ module Wx
|
|
57
57
|
# <p>This function is categorized as a GUI one and so is not thread-safe.
|
58
58
|
# </p>
|
59
59
|
# </div>
|
60
|
-
#
|
61
|
-
# Include file: \#include <wx/utils.h>
|
62
60
|
# @return [void]
|
63
61
|
def self.bell; end
|
64
62
|
|
@@ -150,8 +148,6 @@ module Wx
|
|
150
148
|
# <p>For some configurations of the running user, the application which is launched to open the given URL may be URL-dependent (e.g. a browser may be used for local URLs while another one may be used for remote URLs).
|
151
149
|
# </p>
|
152
150
|
# </div>
|
153
|
-
#
|
154
|
-
# Include file: \#include <wx/utils.h>
|
155
151
|
# @see launch_default_application
|
156
152
|
# @see execute
|
157
153
|
# @param url [String]
|
@@ -171,8 +167,6 @@ module Wx
|
|
171
167
|
# Copies the user's email address into the supplied buffer, by concatenating the values returned by {get_full_host_name} and {get_user_id}.
|
172
168
|
#
|
173
169
|
# true if successful, false otherwise.
|
174
|
-
#
|
175
|
-
# Include file: \#include <wx/utils.h>
|
176
170
|
# @return [String]
|
177
171
|
def self.get_email_address; end
|
178
172
|
|
@@ -192,8 +186,6 @@ module Wx
|
|
192
186
|
#
|
193
187
|
# Please note that the returned name is not fully qualified, i.e. it does not include the domain name.
|
194
188
|
# The hostname if successful or an empty string otherwise.
|
195
|
-
#
|
196
|
-
# Include file: \#include <wx/utils.h>
|
197
189
|
# @see get_full_host_name
|
198
190
|
# @return [String]
|
199
191
|
def self.get_host_name; end
|
@@ -217,8 +209,6 @@ module Wx
|
|
217
209
|
#
|
218
210
|
# something like "jsmith"). It uniquely identifies the current user (on this system). Under Windows or NT, this function first looks in the environment variables USER and LOGNAME; if neither of these is found, the entry <b>UserId</b> in the <b>wxWidgets</b> section of the WIN.INI file is tried.
|
219
211
|
# The login name if successful or an empty string otherwise.
|
220
|
-
#
|
221
|
-
# Include file: \#include <wx/utils.h>
|
222
212
|
# @see get_user_name
|
223
213
|
# @return [String]
|
224
214
|
def self.get_user_id; end
|
@@ -227,8 +217,6 @@ module Wx
|
|
227
217
|
#
|
228
218
|
# Under Windows or NT, this function looks for the entry UserName in the wxWidgets section of the WIN.INI file. If PenWindows is running, the entry Current in the section User of the PENWIN.INI file is used.
|
229
219
|
# The full user name if successful or an empty string otherwise.
|
230
|
-
#
|
231
|
-
# Include file: \#include <wx/utils.h>
|
232
220
|
# @see get_user_id
|
233
221
|
# @return [String]
|
234
222
|
def self.get_user_name; end
|
@@ -260,8 +248,6 @@ module Wx
|
|
260
248
|
# <p>This function is not 100% reliable on some systems given the fact that there isn't always a standard way to do a reliable check on the OS bitness.
|
261
249
|
# </p>
|
262
250
|
# </div>
|
263
|
-
#
|
264
|
-
# Include file: \#include <wx/utils.h>
|
265
251
|
# @return [Boolean]
|
266
252
|
def self.is_platform64bit; end
|
267
253
|
|
@@ -303,8 +289,6 @@ module Wx
|
|
303
289
|
# </div>
|
304
290
|
#
|
305
291
|
# true on success, false if an error occurred.
|
306
|
-
#
|
307
|
-
# Include file: \#include <wx/utils.h>
|
308
292
|
# @param flags [Integer] One of {Wx::SHUTDOWN_POWEROFF}, {Wx::SHUTDOWN_REBOOT} or {Wx::SHUTDOWN_LOGOFF} (currently implemented only for MSW) possibly combined with {Wx::SHUTDOWN_FORCE} which forces shutdown under MSW by forcefully terminating all the applications. As doing this can result in a data loss, this flag shouldn't be used unless really necessary.
|
309
293
|
# @return [Boolean]
|
310
294
|
def self.shutdown(flags=Wx::SHUTDOWN_POWEROFF) end
|
@@ -90,7 +90,7 @@ module Wx
|
|
90
90
|
# Constructor.
|
91
91
|
#
|
92
92
|
# It is not normally used by the user code as the objects of this type are constructed by {Wx::Wizard}.
|
93
|
-
# @param type [Wx::
|
93
|
+
# @param type [Wx::Notebook::EventType]
|
94
94
|
# @param id [Integer]
|
95
95
|
# @param direction [Boolean]
|
96
96
|
# @param page [Wx::WizardPage]
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# :stopdoc:
|
2
|
+
# Copyright (c) 2023 M.J.N. Corino, The Netherlands
|
3
|
+
#
|
4
|
+
# This software is released under the MIT license.
|
5
|
+
# :startdoc:
|
6
|
+
|
7
|
+
|
8
|
+
module Wx
|
9
|
+
|
10
|
+
# Function used to create the correct persistent adapter for the given object.
|
11
|
+
#
|
12
|
+
# This is a compatibility function that simply redirects the call to the object itself. Any object class
|
13
|
+
# supporting persistence should implement the #create_persistent_object method to return a Wx::PersistentObject
|
14
|
+
# instance for the object it is called for.
|
15
|
+
# This method raises a NoImplementError if the object class does not support persistence.
|
16
|
+
# @see Defining Custom Persistent Windows
|
17
|
+
# @param obj [Object]
|
18
|
+
# @return [Wx::PersistentObject]
|
19
|
+
def self.create_persistent_object(obj) end
|
20
|
+
|
21
|
+
# A shorter synonym for {Wx::PersistenceManager#register_and_restore}.
|
22
|
+
#
|
23
|
+
# This function simply calls {Wx::PersistenceManager#register_and_restore} but using it results in slightly shorter
|
24
|
+
# code as it calls {Wx::PersistenceManager.get} internally. As an additional convenience, this function can also set the window name.
|
25
|
+
#
|
26
|
+
# Returns true if the settings were restored or false otherwise (this will always be the case when the program runs
|
27
|
+
# for the first time, for example).
|
28
|
+
# @param obj [Wx::Window] window to register with persistence manager and to try to restore the settings for.
|
29
|
+
# @param name [String] If specified non-empty, window name is changed to the provided value before registering it.
|
30
|
+
# @return [Boolean]
|
31
|
+
def self.persistent_register_and_restore(obj, name=nil) end
|
32
|
+
|
33
|
+
# class alias
|
34
|
+
PersistentWindow = PersistentWindowBase
|
35
|
+
|
36
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# :stopdoc:
|
2
|
+
# Copyright (c) 2023 M.J.N. Corino, The Netherlands
|
3
|
+
#
|
4
|
+
# This software is released under the MIT license.
|
5
|
+
# :startdoc:
|
6
|
+
|
7
|
+
|
8
|
+
module Wx
|
9
|
+
|
10
|
+
class PersistentObject < ::Object
|
11
|
+
|
12
|
+
# Save the specified value using the given name.
|
13
|
+
# @param [String] name The name of the value in the configuration file.
|
14
|
+
# @param [Object] value The value to save, currently must be a type supported by wxConfig.
|
15
|
+
# @return [Boolean] true if the value was saved or false if an error occurred.
|
16
|
+
def save_value(name, value); end
|
17
|
+
protected :save_value
|
18
|
+
|
19
|
+
# Restore a value saved by {#save_value}.
|
20
|
+
# @param [String] name The name of the value in the configuration file.
|
21
|
+
# @return [Object,nil] The value if successfully read, nil otherwise
|
22
|
+
def restore_value(name); end
|
23
|
+
protected :restore_value
|
24
|
+
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# :stopdoc:
|
2
|
+
# Copyright (c) 2023 M.J.N. Corino, The Netherlands
|
3
|
+
#
|
4
|
+
# This software is released under the MIT license.
|
5
|
+
# :startdoc:
|
6
|
+
|
7
|
+
|
8
|
+
module Wx
|
9
|
+
|
10
|
+
class TopLevelWindow < NonOwnedWindow
|
11
|
+
|
12
|
+
# Creates PersistentObject for this toplevel window instance (incl. Dialog and Frame).
|
13
|
+
# @see Wx.create_persistent_object
|
14
|
+
# @return [Wx::PersistentTLW]
|
15
|
+
def create_persistent_object; end
|
16
|
+
|
17
|
+
end
|
18
|
+
|
19
|
+
end
|
data/lib/wx/doc/treebook.rb
CHANGED
@@ -7,13 +7,18 @@
|
|
7
7
|
|
8
8
|
module Wx
|
9
9
|
|
10
|
-
class Treebook
|
10
|
+
class Treebook < BookCtrlBase
|
11
11
|
|
12
12
|
# Returns the Wx::TreeCtrl used for this Treebook
|
13
13
|
# @return [Wx::TreeCtrl] the tree control
|
14
14
|
def get_tree_ctrl; end
|
15
15
|
alias :tree_ctrl :get_tree_ctrl
|
16
16
|
|
17
|
+
# Creates PersistentObject for this treebook control instance.
|
18
|
+
# @see Wx.create_persistent_object
|
19
|
+
# @return [Wx::PersistentTreeBookCtrl]
|
20
|
+
def create_persistent_object; end
|
21
|
+
|
17
22
|
end
|
18
23
|
|
19
24
|
end
|
data/lib/wx/version.rb
CHANGED