visualruby 3.6.13 → 3.6.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66e329b9988177b51b625d9c0a8c1aa9742b9c21ced11008be00f6316c2ebe66
-  data.tar.gz: 11f780e86b0afaf528173ec155b45a79c0016620fa2db113a0aa9fdcf4543317
+  metadata.gz: 6d6384dee7a727f896f647631d0b81a1b2921a6d8d741dbfac6df585230a84f7
+  data.tar.gz: fc32786c5f99ce6d78df5245a59664912b7e93a0555b0bd574fad752f6ef6036
 SHA512:
-  metadata.gz: 4cb6911da7acf32f9739013af87bd1f7fbdcbce517e7a8064ecb9a34b39d986752dcd2652cb3787307c3bd2a6f959e54afdf15458dc50137b3b0964f93d0668f
-  data.tar.gz: f9865661980f8e056901976f92e8faa466664dbc174a9e0aa4ef75b6fca15ad34f0fcd97d8709ddd99c3524b080d33b7979527a097a33e8af80c506db32bb072
+  metadata.gz: 98a5f796fb59bc9fed8d80f66b27a14e47ce70e6294e35c10c5e513d2e8e098e85026a31ea047bf2747e2de49d0008614e31080f4785cce198e940a761e036f1
+  data.tar.gz: a56b6f8cd115b489cc38648c3be7d58c648ec7b362c9d8a527381ad5715721660765ef3964b48a7f87ec8d9fc4fcd180d4b6a28957be4ad399d98bbcf9e474aa

data/.vr_settings.yaml

@@ -3,39 +3,23 @@ vr_yaml_file: "/home/eric/vrp/vr3/.vr_settings.yaml"
 width: 1854
 height: 1003
 panel_pos: 353
-notebook_panel_position: 622
+notebook_panel_position: 734
 run_command_line: vr
 open_files:
 - "/home/eric/vrp/vr3/lib/GladeGUI.rb"
 - "/home/eric/vrp/vr3/src/main/VR_Main.rb"
-- "/home/eric/vrp/vr3/vr"
-- "/home/eric/vrp/vr3/src/editor/VR_Document.rb"
-- "/home/eric/vrp/vr3/src/main/VR_Tools.rb"
-- "/home/eric/vrp/vr3/src/main/OpenProject.rb"
-- "/home/eric/vrp/vr3/src/version.rb"
-- "/home/eric/vrp/vr3/lib/Alert.rb"
-- "/home/eric/vrp/vr3/lib/vrlib.rb"
-- "/home/eric/vrp/vr3/lib/AlertDialog.rb"
-- "/home/eric/vrp/vr3/src/main/NewProjectGUI.rb"
 - "/home/eric/vrp/vr3/src/editor/VR_Tabs.rb"
-- "/home/eric/vrp/vr3/examples/06_alert_box/alertdemo.rb"
-- "/home/eric/vrp/vr3/examples/35_child_window/child_window.rb"
-- "/home/eric/vrp/vr3/examples/71_prettify_view/prettify_view.rb"
-- "/home/eric/vrp/vr3/examples/72_object_views/object_views.rb"
-- "/home/eric/vrp/vr3/examples/78_listview/listview.rb"
-- "/home/eric/vrp/vr3/examples/78_listview_objects/listviewobjects.rb"
-- "/home/eric/vrp/vr3/examples/95_active_record/active_record.rb"
-- "/home/eric/vrp/vr3/examples/97_active_record2/main.rb"
+- "/home/eric/vrp/vr3/src/main/VR_File_Tree.rb"
+- "/home/eric/vrp/vr3/examples/78_listview/src/SongListViewGUI.rb"
+- "/home/eric/vrp/vr3/lib/treeview/FileTreeView.rb"
+- "/home/eric/vrp/vr3/vr"
 - "/home/eric/vrp/vr3/vr.gemspec"
+- "/home/eric/vrp/vr3/src/main/VR_ENV_GLOBAL.rb"
+- "/home/eric/vrp/vr3/src/version.rb"
+- "/home/eric/vrp/vr3/src/main/VR_ENV.rb"
 open_folders:
 - "/home/eric/vrp/vr3"
-- "/home/eric/vrp/vr3/lib"
-- "/home/eric/vrp/vr3/lib/glade"
-- "/home/eric/vrp/vr3/site"
-- "/home/eric/vrp/vr3/skeleton"
-- "/home/eric/vrp/vr3/skeleton/document"
 - "/home/eric/vrp/vr3/src"
-- "/home/eric/vrp/vr3/src/editor"
 - "/home/eric/vrp/vr3/src/main"
 - "/home/eric/vrp/vr3/src/main/glade"
 current_file: "/home/eric/vrp/vr3/src/version.rb"

data/examples/01_phantom/.vr_settings.yaml

@@ -3,10 +3,9 @@ vr_yaml_file: "/home/eric/vrp/vr3/examples/01_phantom/.vr_settings.yaml"
 width: 1854
 height: 1003
 panel_pos: 360
-notebook_panel_position: 742
+notebook_panel_position: 630
 run_command_line: phantom.rb
 open_files:
-- "/home/eric/vrp/vr3/src/main/NewProjectGUI.rb"
 - "/home/eric/vrp/vr3/examples/01_phantom/README.txt"
 - "/home/eric/vrp/vr3/examples/01_phantom/phantom.rb"
 - "/home/eric/vrp/vr3/examples/01_phantom/src/Phantom.rb"
@@ -14,8 +13,8 @@ open_folders:
 - "/home/eric/vrp/vr3/examples/01_phantom"
 - "/home/eric/vrp/vr3/examples/01_phantom/src"
 - "/home/eric/vrp/vr3/examples/01_phantom/src/glade"
-current_file: "/home/eric/vrp/vr3/examples/01_phantom/src/Phantom.rb"
-current_line: 8
+current_file: "/home/eric/vrp/vr3/examples/01_phantom/phantom.rb"
+current_line: 3
 rdoc_command_line: rdoc -x README
 builder: !ruby/object:Gtk::Builder {}
 top_level_window: false

data/examples/01_phantom/README.txt

@@ -0,0 +1,50 @@
+
+To start, click the "Run" button, and the program will appear.
+
+Clicking the run button, simply runs this command: 
+
+ruby phantom.rb
+
+You can see and edit the "Run" command in menu:  Tools > Project Settings 
+
+Try right-clicking on the files on the left to see options.
+
+Next, try editing a glade file by clicking on the glade folder,
+and double clicking on Phantom.glade.  If this does't work,
+you need to install the Glade Interface Designer.  Glade needs to be installed
+such that it runs from the command prompt using the command, "glade"
+
+These lines of code are what makes the program work:
+
+require 'vrlib'
+ 
+and
+
+include GladeGUI
+
+The GladeGUI module is in vrlib.rb, and it contains the vital methods
+to transform a class into a GUI program.
+
+One important method in GladeGUI is the #show_glade() method.  It reads the
+glade file, and shows it on the screen. 
+
+So this line of code:
+
+Phantom.new.show_glade()
+
+Creates an instance of the Phantom class, then loads Phantom.glade, then
+finds a window with ID "window1" in the glade file, and show it onscreen.
+  
+
+Summary:
+1) Always require "vrlib" in your programs.
+2) Then, include GladeGUI to any class that has a GUI.
+3) Visualruby will automatically find the glade files in the glade folder.
+4) It will load the glade file, find ID "window1", and show it. 
+
+
+Click the "Run" button to see this in action.  Then click the "Open Project" button
+to move on to example 2 ....
+
+
+

data/examples/01_phantom/phantom.rb

@@ -1,6 +1,6 @@
 
 
-require "vrlib"
+require "vrlib.rb"
 
 require_relative "src/Phantom.rb"
 

data/examples/01_phantom/src/glade/Phantom.glade

@@ -5,7 +5,6 @@
   <object class="GtkWindow" id="window1">
     <property name="width-request">400</property>
     <property name="can-focus">False</property>
-    <property name="window-position">center</property>
     <child>
       <object class="GtkBox" id="box1">
         <property name="visible">True</property>

data/examples/02_hello/.vr_settings.yaml

@@ -8,15 +8,14 @@ run_command_line: hello.rb
 open_files:
 - "/home/eric/vrp/vr3/examples/02_hello/README.txt"
 - "/home/eric/vrp/vr3/examples/02_hello/hello.rb"
-- "/home/eric/vrp/vr3/examples/02_hello/src/HelloGUI.rb"
 open_folders:
 - "/home/eric/vrp/vr3/examples/02_hello"
 - "/home/eric/vrp/vr3/examples/02_hello/src"
 - "/home/eric/vrp/vr3/examples/02_hello/src/glade"
-current_file: "/home/eric/vrp/vr3/examples/02_hello/README.txt"
-current_line: 24
-builder: !ruby/object:Gtk::Builder {}
+current_file: "/home/eric/vrp/vr3/examples/02_hello/hello.rb"
+current_line: 9
 rdoc_command_line: rdoc -x README
+builder: !ruby/object:Gtk::Builder {}
 top_level_window: false
 browser: firefox
 backup_path: "/home/eric"

data/examples/02_hello/README.txt

@@ -0,0 +1,50 @@
+
+This "hello world" script is simple, but there are some important lessons
+to be learned from it.
+
+As before, the HelloGUI.rb class has a corresponding glade file, HelloGUI.glade, to add a GUI.
+It maps like this:
+
+HelloGUI.rb  ==>  glade/HelloGUI.glade
+
+If you doubleclick on HelloGUI.glade, the file will open, and you can see
+the button with ID: "ui_hello_btn"  
+
+This ID follows a naming convention:
+
+  ui = user interface
+  hello = identifier
+  btn = a button
+
+This naming convention isn't required, but it helps distinguish a variable that
+refers to a widget from one of your variables.
+
+The main program creates an instance of the HelloGUI class and shows it:
+
+  HelloGUI.new().show_glade()
+
+The following method uses this ID, such that it runs when the button is clicked:
+
+From HelloGUI.rb:
+
+  def ui_hello_btn__clicked(*args)
+    alert("Hello World") 
+  end
+
+
+The name of this method is definately not an accident.  It follows a naming convention:
+
+<GladeID>__<event>      # two underscores between ID and event!
+
+So the method, ui_hello_btn__clicked(*args) runs when the button with glade ID "ui_hello_btn"
+encounters a "clicked" event.  To make this work, you only need to create a unique glade ID and
+name your method correctly.  It will call the method based on its name.
+
+
+SUMMARY:
+1) Give the widgets on the form unique glade IDs, then refer to them by their ID.
+2) Store your glade files in the subdirectory /glade.  Mapping:  MyClass.rb => glade/MyClass.glade
+3) Visualruby will call event handlers by the naming convention: <GladeID>__<event> (see next examples)
+
+
+

data/examples/03_builder_variable/README.txt

@@ -0,0 +1,36 @@
+
+This example shows how a instance variable named @builder is 
+automatically created when the show_glade() method is called.
+It runs this code:
+
+  @builder = Gtk::Builder.new(file: "glade/BuilderDemo.glade")
+
+which loads the glade file into the @builder variable.  This is done
+behind the scenes in GladeGUI, so the @builder variable will magically
+apper in your script.
+
+The @builder variable holds references to all the widgets (and windows etc).
+You can access any widget using its glade ID:
+
+  widget = @builder[:ui_widget_btn]
+
+You can get and set properties:
+
+  my_button = @builder[:ui_widget_btn]      # retreives reference to button
+  puts my_button.label                      # using GtkLabel's "label" property.
+  my_button.label = "Click Me"              # Changes button's text to "Click Me"
+
+
+However, the @builder variable isn't created until show_glade() is called
+so it isn't useable in the initialize() method.  But you can use it in a method,
+before_show().  This is a method that's automatically called before
+the window is shown.
+
+SUMMARY:
+1) The @builder variable is created when you call show_glade()
+2) Every item in the glade form can be retreived with its glade ID
+3) @builder is an instance variable so visible to subclasses etc.
+
+
+
+  

data/examples/04_before_show/README.txt

@@ -0,0 +1,27 @@
+
+The before_show() method
+
+When you create a form, you'll often want to initialize it with data.
+
+However, the initialize() method can't be used to set-up your form because the @builder
+variable hasn't been created yet.  In the initialize() method, @builder = nil!
+So you must use the before_show() method because it runs after initialize() and
+before the show() method.
+
+The before_show() method is automatically called just before a form is shown
+on the screen.  It gives you an opportunity to set-up your form with data, just before
+being shown.  It is optional, but if you write a before_show() method, it will 
+automatically be called when you call the show_glade() method.  
+There is no need to explicitly call it.
+
+
+Typically in the before_show() method, you populate your form:
+
+  def before_show()
+    @view = VR::ListView.new(...)
+    @builder["scrolledwindow1"].add_child(@view)  # add custom listview to scrolledwindow1
+    @builder["button1"].label = get_customer_name()
+  end
+
+Anything can be done because you have the @builder variable which references everything
+on the form.

data/examples/05_menus/README.txt

@@ -0,0 +1,38 @@
+
+Menus
+
+You can easily make menus and toolbars in glade without any lines of code.  You
+just insert a menu into your form using glade, and give each menu item a unique name, then
+create a method to run when the user selects the menu item.
+
+You can see the menus for this example program by double-clicking the Menus.glade file.  Then
+right-click on the MenuBar in the tree and select "Edit." 
+You'll see that theres a menu and a toolbar with the following menu items:
+
+  ui_open_menu
+  ui_save_menu
+  ui_quit_menu
+  
+  ui_zoom_tool
+  ui_home_tool
+  etc.
+ 
+
+When you select a menu item, an event named "activate" is fired, so you can write
+a method to handle this event:
+
+  def ui_open_menu__activate(*args)
+    alert("Open clicked...")
+  end 
+
+Likewise, the toolbar items are buttons so they have a "clicked" event:
+
+  def ui_zoom_tool__clicked(*args)
+    alert("Zooming in...")
+  end
+
+You can build the whole thing in glade, then just write event handlers with the
+naming convention:
+
+<GladeID>__<event>    # two underscores!
+

data/examples/06_alert_box/README.txt

@@ -0,0 +1,71 @@
+
+Alert Box Examples 
+
+The alert() method can be used anywhere in your script.
+It is a simple pop-up window that gives the user a message
+with optional input.
+
+The most basic example is popping up a message on the screen:
+
+  alert("Hello World")
+
+But it can do much more using optional parameters.  
+
+You can add a headline or title:
+
+  alert("Nice to see you", headline: "Hello World")
+
+
+It has the option to have additional buttons:
+
+  button_yes:    (returns data or true)
+  button_no:     (returns false)
+  button_cancel: (returns nil)
+
+So you can program it to do anything with those options:
+
+  answer = alert("Hello", button_yes: "Hi", button_cancel: "Goodbye")
+
+This will show an alert pop-up with a button saying "Hi" and "Goodbye"
+And it will return a value for the button clicked.
+You can write code to respond to clicking these buttons.
+
+You have several options to get users to input data using the :data option:
+
+  answer = alert("Enter your name:", data: "Name goes here...")
+
+This will return a string for the name.  There are a few ways to ask for data
+in alert().  It depends on the type of data you send it.  In the last example, 
+we sent it a String, and it shows a Gtk::Entry to edit the string.  You can also
+pass it an array or a hash:
+
+String  ==>  Entry box
+Array   ==>  Drop Down chooser menu
+Hash    ==>  Multiple Entry Boxes
+
+Press the Run button to see them in action.
+
+Most of the time, you'll just use a simple "ok" and "cancel" button, but you have
+the option to add a :no_button to do any other task:
+
+  answer = alert("Enter name/password:", data: { name: "", password: ""}, button_no: "Forgot Password")
+
+Now there is a third button to do something else if they forgot their password.
+
+Here are all the options:
+
+ :buton_yes = label for button that returns true (default: "Ok", "Save" when input_text is set))
+ :button_no = label for button that returns false (default "Cancel" when input text is set)
+ :button_cancel = label for button that returns nil
+ :data = data for user to edit.  (String, Hash, or Array)
+ :width = with of window (used to make longer messages with wrapping look good.)
+ :title = title of the window (appears in bar at top) Default = :headline
+ :headline = large text that appears at the top.
+ :parent = reference to parent window.  Alert box will always be on top of this parent. Usually=self!
+
+
+
+
+
+
+

data/examples/06_alert_box/alertdemo.rb

@@ -1,12 +1,10 @@
 
-require "vrlib"
+require_relative "./../../lib/vrlib"
 
 require_relative "src/AlertBoxDemo.rb"
 
-
-
-main = Gtk::Application.new()
+main = Gtk::Application.new("org.visualruby.main")
 main.signal_connect "activate" do |app|
-  AlertBoxDemo.new.show_glade()
+  app = AlertBoxDemo.new.show_glade()
 end
 main.run 

data/examples/07_event_handlers/README.txt

@@ -0,0 +1,81 @@
+
+This demonstrates how visualruby handles events.
+
+An example of an event is when a user clicks a button.
+The button itself is an instance of Gtk::Button, and it has an event
+associated with it called "clicked".  When the user clicks the 
+buttion, the "clicked" event occurs, calling a method to take some action.
+
+The code would look like this if you did everything without the benefit of
+visualruby or glade:
+
+  @button = Gtk::Button.new(label: "Say hello")
+  @button.signal_connect "clicked" do |_widget|
+    puts "Hello World!!"
+  end
+
+You are free to write code like this.  However, its much easier and faster in visualruby.
+
+With visualruby, you can create your button in glade exacly how you like it, then
+give it a name like:  ui_hello_but.  Then you can write a method for
+the ui_hello_but by simply using this naming convention:
+
+  def ui_hello_but__clicked(*args)   # two underscores!
+    puts "Hello World!!"
+  end
+
+Visualruby will automatically find this method, and execute the code based
+on the method's naming convention.
+
+It takes the form:
+
+  object__event_name(*args)  # *args just captures arguments, often ignored
+
+When you run your program,  visualruby will look at all the names of methods,
+and if it sees a name that has 2 underscores,  it will look for an
+object and an event to match it to.  In our example, it would find the method,
+#ui_hello_but__clicked, and see that ui_hello_but is a button on the glade
+form, and the button has a matching "clicked" event.  So it would run this code
+when the user clicks the button.
+
+Visualruby would run this code under the hood:
+
+  @builder["ui_hello_but"].signal_connect "clicked" do |*args|
+    ui_hello_but__clicked(*args)
+  end
+
+So you don't need to hard code everything, just use the naming convention.
+
+There are three different forms the method name can take:
+
+1) the one described above 
+
+2) It will call event handlers based on an instance variable name:
+
+  @var = @builder["ui_hello_but"]  # var is instance of Gtk::Button
+  def var__clicked(*args)
+    puts "Hello World"
+  end
+
+3) If your class is a subclass of a Gtk::Button:
+
+  class MyClass
+    ...
+    @button = MyButton.new(label: "Hello")  # necessary step!
+  end
+
+  class MyButton < Gtk::Button
+    ...
+
+    def self__clicked(*args)
+      puts "Hello World"
+    end
+
+  end
+
+Note:  it is necessary to have an instance variable that refers to
+your button in order for visualruby to find the self__xxxxx methods.
+If you just insert it into a form, there will be no reference to it.
+
+Using this method, you can write your own custom subclass of Gtk::TextView
+and use it whereever you want.

data/examples/08_interrupt_exit/README.txt

@@ -0,0 +1,40 @@
+
+Closing Windows
+
+Visualruby has some helpful features to handle closing windows.
+
+First, you can make a "cancel button" on any form by simply giving
+it the glade name:
+
+cancelButton
+
+Any button with that name will be recognized, and its window will be closed automatically
+when you press it.  This is nice because you don't need to clutter your code with
+a method named "cancelButton__clicked()" on every form.
+
+However, sometimes it's desirable to interrupt the window closing process
+to avoid data loss.  Sometimes, you want the program to confirm that
+the user wants to discard the data on the form.  Usually, asking, "Are you sure you want to close?"
+
+There's a GTK event named "delete_event" that is fired before the window is destroyed.
+You can write this method to run before the window is destroyed:
+
+  def window1__delete_event(*a)
+    answer = alert("Do you really want to leave?", button_yes: "Yes!", button_no: "No")
+    if answer == true
+      return false  # will close window
+    else
+      return true   # abort and stay here
+    end
+  end
+
+Remember, that ALL windows have the name "window1"
+
+If this method returns false, the window closes.  If it returns true, it leaves the window
+open.  You can try it for yourself by hitting the "run" button now.
+
+So the "destroy" method will kill the window without asking, but all the "close" requests will
+be interrupted, and run the window1__delete_event() method.
+
+
+

data/examples/09_get_glade_variables/README.txt

@@ -0,0 +1,72 @@
+
+Using get_glade_variables and set_glade_variables
+
+Visualruby uses @builder variable to hold references
+to all the GUI components on the glade form.  It's created by GladeGUI.
+So you can retreive the instance of a widget by using its glade name:
+
+@builder["ui_customer_ent"].text = "Harry"
+
+This would likely be a Gtk::Entry for a customer's name that now shows "Harry".
+
+However, usually there will be many fields on the form that need to be filled beyond 
+customer (e.g. address, phone, email etc.)  To initialize your form, you would need 
+to populate the fields like this:
+
+  def before_show()
+    @builder["ui_customer_ent"].text = "Harry"
+    @builder["ui_customer_id_ent"].text = "4356444"
+    @builder["ui_customer_address_ent"].text = "3424 Main St"
+    # etc.
+  end
+
+Then those values would show on the screen.
+
+However, visualruby will do this for you automatically using a method named
+set_glade_variables.  To use it you just need to create instance variables 
+with the same names as your widgets in glade:
+
+  def initialize
+    @ui_customer_ent"    = "Harry"
+    @ui_customer_id_ent  = "4356444"
+    @ui_customer_address_ent = "3424 Main St"
+  end
+
+Then, when the #show_glade method is called, it will automatically call #set_glade_variables
+to do this:
+
+
+    @builder["ui_customer_ent"].text          = @ui_customer_ent
+    @builder["ui_customer_id_ent"].text       = @ui_customer_id_ent
+    @builder["ui_customer_address_ent"].text  = @ui_customer_address_ent
+    # etc.
+
+It's a shortcut to match the names of the instance variables to the glade names
+and fill in the values on the form.    
+
+You can also do the reverse, and read the form values back into the variables
+using method, #get_glade_variables.
+
+This saves even more typing and errors.  You can replace this:
+
+  @ui_customer_ent          =    @builder["ui_customer_ent"].text           
+  @ui_customer_id_ent       =    @builder["ui_customer_id_ent"].text       
+  @ui_customer_id_address   =    @builder["ui_customer_address_ent"].text  
+
+with this:
+
+  get_glade_variables
+
+Now you can save to a database etc.
+
+So the general procedure is to create a list of instance variables in the #initialize method,
+then visualruby will update the form with the values.  When done, retreive the values
+using #get_glade_variables.  
+
+An added benefit is that it creates a nice list of the fields on the 
+form so you don't need to look them up in glade.
+
+This process can be done with many widgets including buttons, images, calendar dates, entries
+etc.  You can see this in the next example.  
+
+

data/examples/10_all_widgets/README.txt

@@ -0,0 +1,35 @@
+
+This example shows a shortcut to assigning initial properties
+to widgets in your glade form.  This method can be used in the
+initialize() method because it only assigns values to variables
+that are later loaded into widgets when show_glade() is called.
+
+So this works:
+
+  def initialize()
+    @ui_splash_img = "src/splash.png"
+  end
+
+In ititialize() @ui_splash_img is a String.  But, when show_glade()
+is called,  it will be loaded into the glade form. 
+The glade form contains an ID named ui_splash_img  (a Gtk::Image)
+This is how GladeGUI loads the string into the Gtk::Image:
+
+  GladeGUI:
+
+  if @builder["ui_splash_img"].is_a Gtk::Image
+    @builder["ui_splash_image"].file = @ui_splash_img
+  end
+
+So its finding where a variable name matches a glade ID and populating
+the widget with the appropriate data.
+
+There is a method named set_glade_variables() in GladeGUI that does
+this translating.  And there is a another method named get_glade_variables()
+that retreives the widget variables back into the instance variables.
+See the example named "get_glade_variables" for more.  
+
+Note: you must add an "adjustment" object to the spinbutton in glade
+to make it work.
+
+

data/examples/20_calculator/README.txt

@@ -0,0 +1,17 @@
+
+This example shows how you can make an array of glade widgets
+that corresponds to an array in ruby, and you can use
+the get_glade_variables and set_glade_variables to
+update between the form and variables.
+
+In the glade form, there are buttons named:
+
+button[0]
+button[1]
+button[2]
+etc.
+
+In ruby there is a  corresponding array with the labels for the buttons.
+When show_glade() is run, it automatically runs set_glade_variables(), loading 
+the ruby array onto the buttons.  Then the calculator uses the labels to do the
+calculations.

data/examples/36_dialog_box/.vr_settings.yaml

@@ -0,0 +1,17 @@
+--- !ruby/object:VR_ENV
+vr_yaml_file: "/home/eric/vrp/vr3/examples/36_dialog_box/.vr_settings.yaml"
+width: 1854
+height: 1003
+panel_pos: 360
+notebook_panel_position: 606
+run_command_line: dialog_box.rb
+open_files:
+- "/home/eric/vrp/vr3/examples/36_dialog_box/README.txt"
+- "/home/eric/vrp/vr3/examples/36_dialog_box/dialog_box.rb"
+- "/home/eric/vrp/vr3/examples/36_dialog_box/src/ChooserDialog.rb"
+open_folders:
+- "/home/eric/vrp/vr3/examples/36_dialog_box"
+- "/home/eric/vrp/vr3/examples/36_dialog_box/src"
+- "/home/eric/vrp/vr3/examples/36_dialog_box/src/glade"
+current_file: "/home/eric/vrp/vr3/examples/36_dialog_box/README.txt"
+current_line: 30

data/examples/36_dialog_box/README.txt

@@ -0,0 +1,30 @@
+
+DIALOG BOXES
+
+Dialog boxes offer the ability to present questions to the user and wait
+for the answer.  They are simply a Gtk::Window that has a run() method that
+blocks the main event loop, and waits for a response.
+
+The alert() method in visualruby uses a dialog box because it needs to wait for
+the user input before proceeding. (see alert_box example)
+
+In fact, the vast majority of the time, you won't need to write your own dialog
+box becuase you can just use the alert() method.
+
+This example, shows a situation where you're asing for a boolean input, so it
+isn't supported by the alert() method.  So, here you can just create a custom
+dialog box with a boolean input.
+
+These dialog boxes can be as extensive as you like.
+
+
+The run() method returns a Gtk::ResponseType object.  It has several preset return values.
+You can see a list of them here: 
+
+https://docs.gtk.org/gtk3/enum.ResponseType.html
+
+You need to set the "Response ID" of each button to tell it which value to return.
+Here, there is a "OK" button with a response id = OK.  That means that when you click it,
+the run() method returns GTK::ResponseType::OK
+
+

data/examples/49_settings_file/.vr_settings.yaml

@@ -12,6 +12,6 @@ open_files:
 open_folders:
 - "/home/eric/vrp/vr3/examples/49_settings_file"
 - "/home/eric/vrp/vr3/examples/49_settings_file/src"
-current_file: "/home/eric/vrp/vr3/examples/49_settings_file/README.txt"
-current_line: 27
+current_file: "/home/eric/vrp/vr3/examples/49_settings_file/save_settings.rb"
+current_line: 12
 rdoc_command_line: rdoc -x README

data/examples/49_settings_file/README.txt

@@ -0,0 +1,33 @@
+
+SAVING A CLASS TO A YAML FILE
+
+Visualruby has 2 methods that allow you to save any instance of a class to a yaml
+file, then retreive it from disk later:
+
+  var = VR::load_yaml(MyClass, "/path/to/file/class_instance.yaml", *args)
+
+and
+
+  VR::save_yaml(var)  # or  VR::save_yaml(self)  from inside class
+
+The first time you use VR::load_yaml(), it will create an instance of MyClass
+with a variable, @vr_yaml_file that records the complete file
+path used for saving and retreiving it.
+
+When you call VR::load_yaml(), it will try to load the file from disk, but if the file
+isn't there, it will create an instance of MyClass that can be saved later.
+
+VR::save_yaml() will write the image of the file to that path.
+
+The "*args" parameter holds all the arguments you wish to pass to the constructor.
+So this happens under the hood:
+
+  me = MyClass.new(*args)
+
+To create a savable class, you just need to 
+
+
+
+
+
+  

data/examples/70_better_views/README.txt

@@ -0,0 +1,64 @@
+
+While Gtk offers a Gtk::TreeView and Gtk::ListView class, they are
+very difficult to use.  Visualruby has created subclasses of Gtk::TreeView
+and Gtk::ListView that are much easier to use.  The TreeView and ListView classes are
+almost the same class so all the methods and properties here can be applied to
+both ListViews and TreeViews.  This example is for a VR::ListView, but everything applies to 
+VR::TreeView too.
+
+The VR::ListView constructor has the benefit of applying names to all the columns:
+
+  @view = VR::ListView( name: String, age: Integer )
+
+The VR::ListView class will keep a hash of column names that can be retreived 
+using the id() method:
+
+  @age = id(:age)  #  ==> 1
+
+This is much easier than Gtk's classes which use numbers to identify columns.
+
+Since VR::ListView is a subclass of Gtk::ListView, you can still use all the properties
+from Gtk::ListView including the ".model" property that holds all the data.
+The ".model" property is like a complete table (or spreadsheet) of data with columns and rows.
+When you access the ".model", you need to use the id() method so you pass a column number:
+
+  row = model.first  # this is model from Gtk::ListView
+  x = row[id(:age)]  # ==> that row's age
+
+In this example, it calls the Gtk::ListView's #append method to add rows:
+
+  row = model.append
+  row[id(:name)] = "Helen"  # same as row[0] = "Helen"
+  etc.
+
+Again, the id() method is converting the column symbol, ":name" to the correct integer
+for the column, so you can identify columns by their symbol.
+
+Summary:
+1) using VR::ListView and VR::Treeveiw allows naming of columns
+2) You can still use Gtk::Listview's methods and properties because it's their superclass
+
+This example creates the most basic VR::ListView, but it can do a lot more including
+changing columns' and cells' appearance, changing the header, sorting etc.
+Click "Open Project" to go to the next example...
+
+
+
+
+There is a list of color names here:
+
+https://drafts.csswg.org/css-color/#named-colors
+
+
+
+
+    
+
+
+
+
+
+
+
+
+    

data/examples/71_prettify_view/README.txt

@@ -0,0 +1,105 @@
+
+The last example showed how easy it is to create a VR::ListView but it needed
+to look a little better.
+
+In this example, we will fix these items:
+
+1) The columns are squished together on the left side.
+2) The width is too wide
+3) The "Balance" numbers and header needs to right-justify, so it forms a column.
+4) The "Balance" numbers should have 2 decimal places.
+5) Negatave balances shold be in red.
+
+First, we fix the attributes of the columns, and later we'll fix the individual cells.
+To change attributes for whole columns,  the col_attr() and col_[attribute_name] methods 
+are used:
+
+  col_width(name: 160, balance: 120)
+  col_attr(:balance, alignment: 1, xalign: 1)  
+
+This will solve issues 1, 2 and 3.  This is a simple example, but the col_attr() method 
+can do much more:
+
+  col_attr(width: 200)  # changes width of ALL columns to 200
+  col_attr(:balance, :name, background: "pink", foreground: "gray")
+
+It can handle any number of columns and attributes.  Also, it works on the column and
+renderer's attributes so you can change renderer's attributes too.  Likewise the 
+col_[attribute_name] method is useful to change one attribute for many columns:
+
+  col_width(200)  # changes all widths to 200 (same as above)
+  col_foreground( "gray", :balance, :name)
+
+The col_[attribute_name] method works for any attribute.  So, col_xalign() and col_background() both work. 
+These methods are very similar: they both just set attributes for columns and renderers.
+But the col_attr sets multiple attributes for columns, whereas the col_[attribute_name] 
+sets a single attribute for multiple columns.  You can use either one.  You can't go wrong.
+
+Individual Cells
+
+To make the negative balances appear in red, and truncate the numbers to 2 decimal places,
+we need to operate on each individual cell.  Gtk::TreeView has a method called,
+set_cell_data_func() that accepts a code block to be executed on each cell, and the result
+gets painted on the screen.  This is a complicated method to use.  VR::ListView added a 
+shortcut method named each_cell_method() that just passes a method to Gtk's set_cell_data_func()
+but is much easier to use:
+
+  def initialize()
+    ...
+    each_cell_method(:balance, method(:make_negatives_red))
+  end    
+
+  def make_negatives_red(col, rend, model, iter)
+      col_id = id(rend.model_sym)
+      balance = iter[col_id]
+      if balance < 0
+          rend.text = "(%.2f)" % balance.abs
+          rend.foreground = "darkred" 
+          rend.weight = 700
+      else
+          rend.text = "%.2f" % balance 
+          rend.foreground = "black"
+          rend.weight = 400 
+      end
+  end
+
+The each_cell_method() line is telling it to call the make_negatives_red() method on each cell
+in the :balance column.  The result will be displayed on the screen.
+
+The make_negatives_red method must accept four parameters, (col, rend, model, iter) because
+the Gtk::TreeView will be passing it those 4 parameters.  This is Gtk's business.  It will
+always pass those parameters, so you must write your method to accept them.
+
+There's a wrinkle to this story:  Because this is a VR::ListView (not Gtk), the make_negatives_red() method
+will be passed a VR::TreeViewColumn, VR::CellRendererText and a VR::Iter instead of their Gtk
+equivalents.
+
+That allows us to do this:
+
+  col_id = id(rend.model_sym)
+  balance = iter[col_id]
+
+So using VR::ListView, you can look up the symbol of the column.  Then use the id() method to
+retreive the column number used by Gtk.  This illustrates the benefits of VR::ListView.
+
+Also, because the make_negatives_red() function looks up the column number for itself, it can
+be reused on any column:
+
+  each_cell_method( :degree_angle,  method(:make_negatives_red))
+  each_cell_method( :weight_diff,   method(:make_negatives_red))
+  each_cell_method( :spin_rate,     method(:make_negatives_red))
+
+This would work on all those number columns.
+ 
+
+There is a list of color names here:
+
+https://drafts.csswg.org/css-color/#named-colors 
+ 
+
+
+
+
+
+
+    

data/examples/75_treeview/.vr_settings.yaml

@@ -4,14 +4,14 @@ width: 1854
 height: 1003
 panel_pos: 491
 notebook_panel_position: 687
-run_command_line: ruby familytree.rb
+run_command_line: familytree.rb
 open_files:
 - "/home/eric/vrp/vr3/examples/75_treeview/familytree.rb"
 open_folders:
 - "/home/eric/vrp/vr3/examples/75_treeview"
 current_file: "/home/eric/vrp/vr3/examples/75_treeview/familytree.rb"
 current_line: 10
-rdoc_command_line: rdoc -x README
 builder: !ruby/object:Gtk::Builder {}
+rdoc_command_line: rdoc -x README
 top_level_window: false
 settings_file_version: 1

data/examples/75_treeview/README.txt

@@ -0,0 +1,25 @@
+Press the "Run" button and see what happens.
+
+This example shows the best way to insert a Gtk::TreeView object into your forms.
+If you double click on the FamilyTree.glade file, you will see that there is no Gtk::TreeView
+in the form.  Instead, there is an empty Gtk::ScrolledWindow named "scrolledwindow1."
+
+This scrolledwindow1 is a blank canvas where we can insert our TreeView.
+
+Glade had a Gtk::TreeView widget that you can insert in glade, but it is very problematic
+to work with because it is stuck in a glade form.  A much better approach is to create
+a custom Gtk::TreeView and insert it into the form like this:
+
+  @builder["scrolledwindow1"].add_child(@my_tree)  
+
+This example uses VR_TreeView from the vrlib library.  It is a subclass of Gtk::TreeView but adds
+a lot of functionality and ease of use.
+
+Its beyond our scope to describe all the complexities of Gtk::TreeView here, but a major
+advantage to using VR::TreeView is that you can use symbols for the field names:
+
+  @tree = VR::TreeView.new(name: String, age: Integer) 
+
+Then identifly the fields by :name and :age instead of a column number as Gtk::TreeView uses.
+
+There will be more on TreeViews and ListViews in the following examples.

data/examples/92_standalone_exe/README.txt

@@ -0,0 +1,43 @@
+
+CREATING A STANDALONE EXE
+
+This project will create a standalone executable file using rubygems.
+The program will run independently from visualruby, but it depends
+on vrlib.rb, therefore it depends on the visualruby gem.
+
+Here are the steps needed to create the executable file, my_program:
+
+1) Right-click my_program and make it the main program (bold).
+
+2) Create the .gemspec file by going to:
+  
+  Tools > Create Gemspec File
+
+This will add a .gemspec file to the project.  It will set the executable file
+to be the main program, my_program.  You can click on it to look at it.
+
+3) Right click on the my_program.gemspec file and Build the gem.  It will then appear
+  in the project.
+
+4) Right-click on the .gem file and select:
+
+  Install Gem
+
+This will install it locally on your computer.  
+
+You can now run my_program at the command line. At the command prompt enter:
+
+  my_program
+
+When you do this process, visualruby is just executing the gem commands.  So
+if you experience and difficulty, just run the commands manually to see what's
+going on:
+
+  gem install my_program-0.0.1.gem --local
+
+etc.  
+
+
+
+
+ 

data/lib/GladeGUI.rb

@@ -482,7 +482,7 @@ def clear_events()
     Gtk.main_iteration
   end
 end
- 
+
 
 
  

data/src/editor/VR_Document.rb

@@ -21,6 +21,8 @@ class VR_Document < GtkSource::View
       buffer.language = GtkSource::LanguageManager.new.get_language("html")
     elsif [".yaml", ".yml"].include?(File.extname(full_path_file))
       buffer.language = GtkSource::LanguageManager.new.get_language("yaml")
+    elsif [".ui", ".glade"].include?(File.extname(full_path_file))
+      buffer.language = GtkSource::LanguageManager.new.get_language("xml")
     else 
       guess_lang = GtkSource::LanguageManager.new.guess_language(File.basename(full_path_file))
       buffer.language = guess_lang

data/src/editor/VR_Tabs.rb

@@ -20,7 +20,8 @@ class VR_Tabs < Gtk::Notebook
               title: "Save File As...",
               parent: @main.builder[:window1],
               action: :save,
-              buttons: [["_Cancel", :cancel], ["_Save", :accept]])
+              buttons: [["_Cancel", :cancel], ["_Save", :accept]])
+    dialog.resize(500, 800)
     dialog.current_folder = File.dirname(@docs[page].full_path_file)
     dialog.current_name = VR_Document.get_class_title(@docs[page].buffer.text) 
     resp = dialog.run 

data/src/main/VR_ENV.rb

@@ -10,8 +10,8 @@ class VR_ENV
 
   #to add setting, just add to list
   def defaults
-    @width ||= 800
-    @height ||= 600
+    @width ||= 700
+    @height ||= 500
     @panel_pos ||= 360
     @notebook_panel_position ||= 300
     @run_command_line ||= "main.rb"

data/src/main/VR_ENV_GLOBAL.rb

@@ -16,7 +16,7 @@ class VR_ENV_GLOBAL
     @glade_path ||= "glade"
     @projects_home ||= File.join(ENV["HOME"], "visualruby")
     @projects_home_open_folders ||= [@projects_home]
-    @default_project ||= File.join(ENV["HOME"], "visualruby", "examples", "alert_box")
+    @default_project ||= File.join(ENV["HOME"], "visualruby", "examples", "01_phantom")
     @home_project ||= @default_project
   end
 

data/src/main/VR_Main.rb

@@ -13,7 +13,7 @@ class VR_Main
   def before_show
 
     # there must be a visualruby directory:
-    required_project = File.join(ENV["HOME"],"","visualruby", "examples", "alert_box")
+    required_project = File.join(ENV["HOME"],"","visualruby", "examples", "01_phantom")
     menuInstallExamples__activate if not VR_Tools.vr_project?(required_project)
 
     # load global settings (requires /home/visuaruby folder exists

data/src/main/glade/VR_Main.glade

@@ -17,6 +17,7 @@
         <property name="orientation">vertical</property>
         <child>
           <object class="GtkMenuBar" id="menubar">
+            <property name="visible">True</property>
             <property name="can-focus">False</property>
             <child>
               <object class="GtkMenuItem" id="menuFile">

data/src/version.rb

@@ -1,4 +1,4 @@
-VERSION = "3.6.13"
+VERSION = "3.6.15"
 GTK_VERSION = "gtk3"
 GTK_SOURCEVIEW_VERSION = "gtksourceview4"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visualruby
 version: !ruby/object:Gem::Version
-  version: 3.6.13
+  version: 3.6.15
 platform: ruby
 authors:
 - Eric Cunningham
@@ -9,7 +9,7 @@ autorequire:
 bindir:
 - "."
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gtk3
@@ -60,49 +60,60 @@ files:
 - "./docs/img/main.png"
 - "./docs/img/ruby_prompt.png"
 - "./examples/01_phantom/.vr_settings.yaml"
+- "./examples/01_phantom/README.txt"
 - "./examples/01_phantom/phantom.rb"
 - "./examples/01_phantom/src/Phantom.rb"
 - "./examples/01_phantom/src/glade/Phantom.glade"
 - "./examples/02_hello/.vr_settings.yaml"
+- "./examples/02_hello/README.txt"
 - "./examples/02_hello/hello.rb"
 - "./examples/02_hello/src/HelloGUI.rb"
 - "./examples/02_hello/src/glade/HelloGUI.glade"
 - "./examples/03_builder_variable/.vr_settings.yaml"
+- "./examples/03_builder_variable/README.txt"
 - "./examples/03_builder_variable/builder.rb"
 - "./examples/03_builder_variable/src/BuilderDemo.rb"
 - "./examples/03_builder_variable/src/glade/BuilderDemo.glade"
 - "./examples/04_before_show/.vr_settings.yaml"
+- "./examples/04_before_show/README.txt"
 - "./examples/04_before_show/before_show.rb"
 - "./examples/04_before_show/src/BeforeShow.rb"
 - "./examples/04_before_show/src/MyClass.rb"
 - "./examples/04_before_show/src/glade/BeforeShow.glade"
 - "./examples/05_menus/.vr_settings.yaml"
+- "./examples/05_menus/README.txt"
 - "./examples/05_menus/menus.rb"
 - "./examples/05_menus/src/Menus.rb"
 - "./examples/05_menus/src/glade/Menus.glade"
 - "./examples/06_alert_box/.vr_settings.yaml"
+- "./examples/06_alert_box/README.txt"
 - "./examples/06_alert_box/alertdemo.rb"
 - "./examples/06_alert_box/src/AlertBoxDemo.rb"
 - "./examples/06_alert_box/src/glade/AlertBoxDemo.glade"
 - "./examples/07_event_handlers/.vr_settings.yaml"
+- "./examples/07_event_handlers/README.txt"
 - "./examples/07_event_handlers/event_handlers.rb"
 - "./examples/07_event_handlers/src/Event_Handlers.rb"
 - "./examples/07_event_handlers/src/MyTextView.rb"
 - "./examples/07_event_handlers/src/glade/Event_Handlers.glade"
 - "./examples/08_interrupt_exit/.vr_settings.yaml"
+- "./examples/08_interrupt_exit/README.txt"
 - "./examples/08_interrupt_exit/interrupt_exit.rb"
 - "./examples/08_interrupt_exit/src/InterruptExit.rb"
 - "./examples/08_interrupt_exit/src/glade/InterruptExit.glade"
 - "./examples/09_get_glade_variables/.vr_settings.yaml"
+- "./examples/09_get_glade_variables/README.txt"
 - "./examples/09_get_glade_variables/get_glade_variables.rb"
 - "./examples/09_get_glade_variables/src/DataObjectGUI.rb"
 - "./examples/09_get_glade_variables/src/glade/DataObjectGUI.glade"
 - "./examples/10_all_widgets/.vr_settings.yaml"
+- "./examples/10_all_widgets/README.txt"
 - "./examples/10_all_widgets/all_widgets.rb"
 - "./examples/10_all_widgets/src/AllWidgets.rb"
 - "./examples/10_all_widgets/src/glade/AllWidgets.glade"
 - "./examples/10_all_widgets/src/splash.png"
 - "./examples/20_calculator/.vr_settings.yaml"
+- "./examples/20_calculator/README.txt"
 - "./examples/20_calculator/calculator.rb"
 - "./examples/20_calculator/src/CalculatorGUI.rb"
 - "./examples/20_calculator/src/glade/CalculatorGUI.glade"
@@ -116,16 +127,24 @@ files:
 - "./examples/35_child_window/src/glade/ModalWindow.glade"
 - "./examples/35_child_window/src/glade/ModelessWindow.glade"
 - "./examples/35_child_window/src/glade/MyChildClass.glade"
+- "./examples/36_dialog_box/.vr_settings.yaml"
+- "./examples/36_dialog_box/README.txt"
+- "./examples/36_dialog_box/dialog_box.rb"
+- "./examples/36_dialog_box/src/ChooserDialog.rb"
+- "./examples/36_dialog_box/src/glade/ChooserDialog.glade"
 - "./examples/49_settings_file/.vr_settings.yaml"
+- "./examples/49_settings_file/README.txt"
 - "./examples/49_settings_file/save_settings.rb"
 - "./examples/49_settings_file/settings.yaml"
 - "./examples/49_settings_file/src/SavableSettings.rb"
 - "./examples/49_settings_file/src/glade/SavableSettings.glade"
 - "./examples/70_better_views/.vr_settings.yaml"
+- "./examples/70_better_views/README.txt"
 - "./examples/70_better_views/better_views.rb"
 - "./examples/70_better_views/src/BetterView.rb"
 - "./examples/70_better_views/src/glade/BetterView.glade"
 - "./examples/71_prettify_view/.vr_settings.yaml"
+- "./examples/71_prettify_view/README.txt"
 - "./examples/71_prettify_view/prettify_view.rb"
 - "./examples/71_prettify_view/src/PrettyView.rb"
 - "./examples/71_prettify_view/src/glade/PrettyView.glade"
@@ -136,6 +155,7 @@ files:
 - "./examples/72_object_views/src/CustomerClass.rb"
 - "./examples/72_object_views/src/glade/BalanceListView.glade"
 - "./examples/75_treeview/.vr_settings.yaml"
+- "./examples/75_treeview/README.txt"
 - "./examples/75_treeview/familytree.rb"
 - "./examples/75_treeview/src/FamilyTree.rb"
 - "./examples/75_treeview/src/glade/FamilyTree.glade"
@@ -184,6 +204,7 @@ files:
 - "./examples/80_golf_handicap/src/glade/Handicap.glade"
 - "./examples/80_golf_handicap/src/glade/Score.glade"
 - "./examples/92_standalone_exe/.vr_settings.yaml"
+- "./examples/92_standalone_exe/README.txt"
 - "./examples/92_standalone_exe/src/MyClass.rb"
 - "./examples/92_standalone_exe/src/glade/MyClass.glade"
 - "./examples/95_active_record/.vr_settings.yaml"
@@ -204,10 +225,6 @@ files:
 - "./examples/97_active_record2/bin/glade/Paycheck.glade"
 - "./examples/97_active_record2/db/development.sqlite3"
 - "./examples/97_active_record2/main.rb"
-- "./examples/dialog_box/.vr_settings.yaml"
-- "./examples/dialog_box/dialog_box.rb"
-- "./examples/dialog_box/src/ChooserDialog.rb"
-- "./examples/dialog_box/src/glade/ChooserDialog.glade"
 - "./img/close.png"
 - "./img/folder.png"
 - "./img/glade.png"
@@ -217,6 +234,7 @@ files:
 - "./img/rb.png"
 - "./img/ruby.png"
 - "./img/splash.png"
+- "./img/ui.png"
 - "./img/unknown.png"
 - "./lib/Alert.rb"
 - "./lib/AlertDialog.rb"

data/examples/dialog_box/.vr_settings.yaml

@@ -1,16 +0,0 @@
---- !ruby/object:VR_ENV
-vr_yaml_file: "/home/eric/vrp/vr3/examples/dialog_box/.vr_settings.yaml"
-width: 1854
-height: 1003
-panel_pos: 360
-notebook_panel_position: 506
-run_command_line: dialog_box.rb
-open_files:
-- "/home/eric/vrp/vr3/examples/dialog_box/dialog_box.rb"
-- "/home/eric/vrp/vr3/examples/dialog_box/src/ChooserDialog.rb"
-open_folders:
-- "/home/eric/vrp/vr3/examples/dialog_box"
-- "/home/eric/vrp/vr3/examples/dialog_box/src"
-- "/home/eric/vrp/vr3/examples/dialog_box/src/glade"
-current_file: "/home/eric/vrp/vr3/examples/dialog_box/src/ChooserDialog.rb"
-current_line: 15