fox_paradise 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e26dfb3b7912622a1a465a66a5f5a93a9eb11ba4f8a3c09cf17a01b42f7043ec
+  data.tar.gz: f2d43768b1500f6282a9c2b30bea67fb69afaab22d8d9cc610be85455e951f77
+SHA512:
+  metadata.gz: 5c9036a4b15ce05d6bf923430211d843456b076a77c57cb154402f52bbf5cd5593447a439d46651e454a6361c81c5afecc8b465bd39d032c1841947f664d927d
+  data.tar.gz: fbad1f842cb3b5fe997876929c3f2fbfd58b8ac76927775cb62b548ab06244438b6531b95170e775694129fd60bc4fae9682deb738e545b9502fe4d11ccd0a2d

data/README.md

@@ -0,0 +1,101 @@
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/fox_paradise.svg)](https://badge.fury.io/rb/fox_paradise)
+
+## Introduction
+
+**FOX** stands for Free Objects for X. It is a small, light-weight
+GUI toolkit for Linux, Windows and Mac OSX.
+
+The **fox_paradise gem**, written in ruby, attempts to **enhance**
+the default fxruby gem.
+
+The chosen API for the fox_paradise gem has been primarily inspired by
+my other GUI-related toolset project called **gtk_paradise**. API
+such as **.on_clicked {}** and similar - expect more goodies to
+come for the fox_paradise gem in the long run. \o/ *does a little
+ASCII dance*
+
+Personally I still use ruby-gtk primarily, since it looks so pretty
+on Linux - but Fox/fxruby is easier to work with on windows
+(without WSL), so I needed some code to help me "bootstrap" that
+as well.
+
+## Installation and Using the project
+
+    gem install fox_paradise
+
+And then:
+
+    require 'fox_paradise'
+
+Note that this currently is hardcoded to fox16. I am using
+**fox version 1.6.57**. In the future this may become more
+flexible, but for now this is how it is.
+
+Next, the content of the file called **SNIPPETS.md** will
+be shown. I gather all fox-specific knowledge into that
+file.
+
+## Auto-initializing
+
+To auto-initialize, do simply require the fox_paradise gem
+in the following manner:
+
+    require 'fox_paradise/autoinitialize'
+
+## Tooltips:
+
+Tooltips can be set via:
+
+    button.tipText = ' Push Me! '
+
+If you use the fox_paradise gem then the .hint alias exists:
+
+    button.hint = ' Push Me! '
+
+## Buttons:
+
+To add a shortcut, as a key-combination, prefix the text
+via '&'. Example:
+
+    button = FXButton.new(main, "&Hello, World!", nil, application, FXApp::ID_QUIT)
+
+You can give the button HTML colours such as:
+
+    button.background_colour = :steelblue
+
+And you can set the foreground colour as well:
+
+    button.foreground_colour = :lightblue
+    button.foreground = :royalblue # this works as well
+
+This functionality depends on the **colours** gem.
+
+
+
+## Contact information
+
+If your creative mind has ideas and specific suggestions to make this
+gem more useful in general, feel free to drop me an email at any
+time, via:
+
+    shevy@inbox.lt
+
+Before that email I used an email account at Google gmail, but in **2021** I
+decided to slowly abandon gmail for various reasons. In part this is because
+the UI annoys me (on non-chrome browser loading takes too long), but also
+because of Google's attempt to establish mass surveillance via its
+federated cohorts sniffing (FLoC). I do not know what happened at Google,
+but enough is enough - there is only so much you can take while supporting
+greed. When it comes to data mining done by private groups, ultimately
+the user became the product.
+
+Do keep in mind that responding to emails may take some time,
+depending on the amount of work I may have at that moment, due
+to reallife time constraints. I will, however had, read feedback
+eventually. Patches and code changes are welcome too, of course,
+as long as they are in the spirit of the project at hand, e. g.
+fitting to the general theme. For this I may make use of github
+as a discussion site, but this has a low priority right now.
+

data/doc/README.gen

@@ -0,0 +1,75 @@
+RUBY_HEADER
+
+## Introduction
+
+**FOX** stands for Free Objects for X. It is a small, light-weight
+GUI toolkit for Linux, Windows and Mac OSX.
+
+The **fox_paradise gem**, written in ruby, attempts to **enhance**
+the default fxruby gem.
+
+The chosen API for the fox_paradise gem has been primarily inspired by
+my other GUI-related toolset project called **gtk_paradise**. API
+such as **.on_clicked {}** and similar - expect more goodies to
+come for the fox_paradise gem in the long run. \o/ *does a little
+ASCII dance*
+
+Personally I still use ruby-gtk primarily, since it looks so pretty
+on Linux - but Fox/fxruby is easier to work with on windows
+(without WSL), so I needed some code to help me "bootstrap" that
+as well.
+
+## Installation and Using the project
+
+    gem install fox_paradise
+
+And then:
+
+    require 'fox_paradise'
+
+Note that this currently is hardcoded to fox16. I am using
+**fox version 1.6.57**. In the future this may become more
+flexible, but for now this is how it is.
+
+Next, the content of the file called **SNIPPETS.md** will
+be shown. I gather all fox-specific knowledge into that
+file.
+
+## Auto-initializing
+
+To auto-initialize, do simply require the fox_paradise gem
+in the following manner:
+
+    require 'fox_paradise/autoinitialize'
+
+## Tooltips:
+
+Tooltips can be set via:
+
+    button.tipText = ' Push Me! '
+
+If you use the fox_paradise gem then the .hint alias exists:
+
+    button.hint = ' Push Me! '
+
+## Buttons:
+
+To add a shortcut, as a key-combination, prefix the text
+via '&'. Example:
+
+    button = FXButton.new(main, "&Hello, World!", nil, application, FXApp::ID_QUIT)
+
+You can give the button HTML colours such as:
+
+    button.background_colour = :steelblue
+
+And you can set the foreground colour as well:
+
+    button.foreground_colour = :lightblue
+    button.foreground = :royalblue # this works as well
+
+This functionality depends on the **colours** gem.
+
+EMBED_THIS_FILE SNIPPETS.md
+
+ADD_CONTACT_INFORMATION

data/doc/SNIPPETS.md

@@ -0,0 +1,161 @@
+This file will collect fxruby-related snippets.
+
+To require fxruby, do:
+
+    require 'fox16'
+
+Toplevel inclusion via:
+
+    include Fox # I don't recommend it, though.
+
+Create a new application:
+
+    application = Fox::FXApp.new # The application object is responsible for the main event loop.
+    application = Fox::FXApp.new('Hello World!', 'FoxTest')
+    application = Fox::FXApp.new
+
+Create a new main window:
+
+    # first argument should be a FXApp instance:
+    main_window = Fox::FXMainWindow.new(application, 'Hello', nil, nil, DECOR_ALL)
+    main_window = Fox::FXMainWindow.new(application, 'Hello')
+
+Subclass from the main window:
+
+    class HelloWindow < Fox::FXMainWindow
+
+Create a button (button tag):
+
+    # The button should be embedded into the main-window:
+    FXButton.new(main_window, "&Hello, Fox World!", nil, application, FXApp::ID_QUIT)
+    button = FXButton.new(main_window, "Hey its me")
+    button = Fox::FXButton.new(main_window, "Hello, World!")
+
+Style a button:
+
+    button = FXButton.new(parent_widget,
+             '&Some text',
+             opts: FRAME_SUNKEN|FRAME_THICK
+           )
+
+    button.frameStyle = FRAME_SUNKEN|FRAME_THICK # Set the frame-style in use.
+
+Add a tooltip to the button (or to other widgets):
+
+    button.tipText = ' Push Me! '
+    button.hint = 'Or use this.' # This is available via the fox_paradise gem.
+
+Add a check-button:
+
+    vertical_frame = FXVerticalFrame.new(self, LAYOUT_SIDE_RIGHT|LAYOUT_FILL_Y|PACK_UNIFORM_WIDTH)
+    check_button = FXCheckButton.new(vertical_frame, "Toolbar Style\tCool \"poppy\" style buttons")
+    check_button.connect(SEL_COMMAND) { |sender, sel, checked|
+      if checked
+        @button.buttonStyle |= BUTTON_TOOLBAR
+        @button.frameStyle   = FRAME_RAISED
+      else
+        @button.buttonStyle &= ~BUTTON_TOOLBAR
+        @button.frameStyle   = FRAME_RAISED|FRAME_THICK
+      end
+    }
+
+Create a vertical frame:
+
+    vertical_frame = FXVerticalFrame.new(self, LAYOUT_SIDE_RIGHT|LAYOUT_FILL_Y|PACK_UNIFORM_WIDTH)
+
+React to on-key-press events (on click actions, click tag, clicked tag):
+
+    button.connect(SEL_COMMAND) { |sender, selector, data|
+      puts 22 * 2222
+    }
+    button.connect(Fox::SEL_COMMAND) { |sender, selector, data|
+      puts 'Hi! And bye!'
+      exit
+    }
+
+Create a text-view widget via FXText:
+
+    @text = FXText.new(main_window)
+    @text.style = FXText::STYLE_UNDERLINE # Underline the text.
+      
+Add a vertical separator:
+
+    Fox::FXVerticalSeparator.new(
+      main_window, Fox::LAYOUT_SIDE_RIGHT|Fox::LAYOUT_FILL_Y|Fox::SEPARATOR_RIDGE
+    )
+
+Add layout hints:
+
+    button.layoutHints = LAYOUT_CENTER_X
+      
+Initialize the application:
+
+    application.create # Do this before .run()
+
+Show stuff in the main-window:
+
+    main_window.show(PLACEMENT_SCREEN) # PLACEMENT_SCREEN ensures that the main window is visible when the program starts to run. This is equivalent to being centered.
+
+Run the application:
+
+    application.run
+
+To use a custom font, on a button, try:
+
+    font = Fox::FXFont.new(@app, 'times', 22)
+    button = Fox::FXButton.new(main_window, name)
+    button.setFont(font) # Set the font here.
+
+    # Or simpler via the fox_paradise_gem:
+
+    USE_THIS_FONT = Fox.font('Hack', 50)
+    button = Fox.button
+    button.use_this_font = USE_THIS_FONT
+  
+Set the font size:
+
+    @font = FXFont.new(app, "Hack,12")
+
+Set a totally custom font:
+
+    "helvetica [bitstream],12,bold,i,normal,iso8859-1,0"
+
+Setting a table (table tag):
+
+    @table = Fox::FXTable.new(frame, opts: 
+               Fox::TABLE_COL_SIZABLE|Fox::TABLE_ROW_SIZABLE|Fox::LAYOUT_FILL_X|Fox::LAYOUT_FILL_Y,
+             padding: 2)
+
+    @table.visibleRows = 20
+    @table.visibleColumns = 8
+
+    @table.setTableSize(50, 14)
+
+    @table.setBackColor(Fox::FXRGB(255, 255, 255))
+    @table.setCellColor(0, 0, Fox::FXRGB(255, 255, 255))
+    @table.setCellColor(0, 1, Fox::FXRGB(255, 240, 240))
+    @table.setCellColor(1, 0, Fox::FXRGB(240, 255, 240))
+    @table.setCellColor(1, 1, Fox::FXRGB(240, 240, 255))
+
+    @table.setItemText(r, c, “r:#{r} c:#{c}”) # Set a specific text.
+    @table.setColumnText(c, Date::MONTHNAMES[c+1]) } # set text on a column.
+
+Colours/Colors in fxruby:
+
+    require 'fox16/colors'
+    blue = Fox::FXColor::Blue # This will refer to blue.
+
+Use a four-splitter widget:
+
+    splitter = FX4Splitter.new(self, LAYOUT_SIDE_TOP|LAYOUT_FILL_X|LAYOUT_FILL_Y|FOURSPLITTER_TRACKING)
+    
+Create a status bar:
+
+    Fox::FXStatusBar.new(self, LAYOUT_SIDE_BOTTOM|LAYOUT_FILL_X|STATUSBAR_WITH_DRAGCORNER)
+
+Fox and FXRuby specific links:
+
+Documentation pertaining to Fox and FXRuby:
+
+    http://fox-toolkit.org/
+    http://fox-toolkit.org/ref16/hierarchy.html

data/doc/TODO.md

@@ -0,0 +1,3 @@
+This file shall detail which changes ought to be made.
+
+------------------------------------------------------------

data/fox_paradise.gemspec

@@ -0,0 +1,44 @@
+# =========================================================================== #
+# Gemspec for fox_paradise.
+# =========================================================================== #
+require 'fox_paradise/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'fox_paradise'
+  s.version = Fox::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+  This library is called fox_paradise. It bundles together code that
+  can be used for the FOX toolkit, via the fxruby bindings.
+
+  The project is very beta-ish though. Do not use it for anything
+  in production yet.
+
+  EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  s.extra_rdoc_files = %w()
+  
+  s.authors    = ['Robert A. Heiler']
+  s.email      = Roebe.email?
+  s.files      = Dir['**/*']
+  s.licenses   = 'LGPL-2.1'
+  s.homepage   = 'https://rubygems.org/gems/fox_paradise'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'fxruby'
+
+}

data/lib/fox_paradise/admin_panel/admin_panel.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === FoxParadise::AdminPanel
+#
+# Usage example:
+#
+#   FoxParadise::AdminPanel.new
+#
+# =========================================================================== #
+# require 'fox_paradise/admin_panel/admin_panel.rb'
+# =========================================================================== #
+require 'colours'
+require 'esystem/method'
+require 'opn'
+require 'save_file'
+require 'fox16'
+
+module FoxParadise
+
+class AdminPanel # < Base # === Foo::AdminPanel
+
+  include Colours
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+pp self # for debugging
+  end
+
+  # ========================================================================= #
+  # === AdminPanel[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  FoxParadise::AdminPanel.new(ARGV)
+end # admin_panel.rb

data/lib/fox_paradise/autoinitialize.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fox_paradise'
+
+Fox.initialize_application_window

data/lib/fox_paradise/examples/001_hello_world.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fox_paradise'
+
+application = Fox.app('Hello World!', 'FoxTest')
+window = Fox.window(application, 'Hello', nil, nil, Fox::DECOR_ALL)
+window.width_height(1400, 800)
+
+Fox.button(
+  window,
+  "&Hello, Fox World!",
+  nil, application,
+  Fox::FXApp::ID_QUIT
+)
+application.create
+window.do_show
+application.run

data/lib/fox_paradise/examples/002_simple_window.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fox_paradise/autoinitialize'
+
+alias e puts
+
+window = Fox.window(Fox.application_window?, 'Hello')
+button = Fox.button(window, "Hey it's me!")
+button.on_clicked { |sender, selector, data|
+  e 'The button was clicked.' # This text will be displayed on the commandline. 
+}
+
+Fox.create_then_run # rb $FOX/simple_windows.rb

data/lib/fox_paradise/examples/003_tool_tip_example.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fox_paradise/autoinitialize'
+
+window = Fox.window(Fox.the_app?, 'Hello')
+
+button = Fox.button(window, 'Hello, World!')
+button.tipText = ' Push Me! '
+button.on_clicked { exit }
+
+Fox::FXToolTip.new(Fox.the_app?)
+
+Fox.create_then_run # rb $FOX/tool_tip_example.rb

data/lib/fox_paradise/examples/004_show_this_image.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fox_paradise/autoinitialize'
+
+USE_THIS_IMAGE = '/home/x/data/images/RPG/SARLEM/CASTLES/TulisNe_Burg.jpg'
+
+# =========================================================================== #
+# Supply your image here:
+# =========================================================================== #
+if ARGV.empty?
+  image_path = USE_THIS_IMAGE
+else
+  image_path = ARGV.first
+end
+
+main_window = Fox.window(::Fox.main_app?, 'Hello')
+# =========================================================================== #
+# Add a button:
+# =========================================================================== #
+button = Fox.button(main_window, "Hello, World!")
+button.hint = 'This will show an image.'
+button.use_this_image = image_path
+button.is_a_quit_button
+Fox.create_then_run

data/lib/fox_paradise/examples/005_two_buttons_in_a_resizable_panel.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fox_paradise/autoinitialize'
+
+alias e puts
+    
+window = Fox.window(Fox.main_application?, :the_filename_is_the_title)
+window.width_height(1400, 800)
+
+# =========================================================================== #
+# === FONT_TO_USE
+# =========================================================================== #
+FONT_TO_USE = Fox.font('Hack', 30)
+
+splitter = Fox::FX4Splitter.new(
+  window, Fox::LAYOUT_SIDE_TOP|Fox::LAYOUT_FILL_X|Fox::LAYOUT_FILL_Y|Fox::FOURSPLITTER_TRACKING
+)
+
+button1 = Fox.button(
+  splitter,
+  '&Button1',
+  nil,
+  Fox.main_application?
+)
+button1.background_colour :black
+button1.foreground_colour :tomato
+button1.pads(80) # This combines pad_right= and pad_left=.
+button1.hint = 'Button #1 can be clicked.'
+button1.on_clicked { e 'Button #1 was clicked.' }
+button1.use_this_font = FONT_TO_USE
+
+button2 = Fox.button(
+  splitter,
+  'B&utton2',
+  nil,
+  Fox.main_application?
+)
+button2.background_colour :lightblue
+button2.foreground_colour :royalblue
+button2.pads(20)
+button2.hint = 'Button #2 can be clicked.'
+button2.on_clicked { e 'Button #2 was clicked.' }
+button2.use_this_font = FONT_TO_USE
+
+Fox.status_bar(window)
+
+Fox.create_then_run

data/lib/fox_paradise/examples/006_notebook_tab_example.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fox_paradise/autoinitialize'
+
+alias e puts
+    
+window = Fox.window(Fox.main_application?, :the_filename_is_the_title)
+window.width_height(1400, 800)
+
+# =========================================================================== #
+# === FONT_TO_USE
+# =========================================================================== #
+FONT_TO_USE = Fox.font('Hack', 30)
+
+# =========================================================================== #
+# Add a small separator:
+# =========================================================================== #
+Fox.horizontal_separator(window)
+
+# =========================================================================== #
+# Contents
+# =========================================================================== #
+contents = Fox.horizontal_frame(window)
+
+# =========================================================================== #
+# Switcher
+# =========================================================================== #
+@tabbook = Fox::FXTabBook.new(contents, opts: Fox::LAYOUT_FILL_X|Fox::LAYOUT_FILL_Y|Fox::LAYOUT_RIGHT)
+
+# =========================================================================== #
+# First tab:
+# =========================================================================== #
+@tab1 = Fox::FXTabItem.new(@tabbook, '&Simple List', nil)
+listframe = Fox::FXHorizontalFrame.new(@tabbook, Fox::FRAME_THICK|Fox::FRAME_RAISED)
+simplelist = Fox::FXList.new(listframe, opts: Fox::LIST_EXTENDEDSELECT|Fox::LAYOUT_FILL_X|Fox::LAYOUT_FILL_Y)
+simplelist.use_this_font = FONT_TO_USE
+simplelist.appendItem('First Entry')
+simplelist.appendItem('Second Entry')
+simplelist.appendItem('Third Entry')
+simplelist.appendItem('Fourth Entry')
+
+# =========================================================================== #
+# Second tab:
+# =========================================================================== #
+@tab2 = Fox::FXTabItem.new(@tabbook, 'F&ile List', nil)
+
+@fileframe = Fox.horizontal_frame(@tabbook, Fox::FRAME_THICK|Fox::FRAME_RAISED)
+
+filelist = Fox::FXFileList.new(@fileframe, opts: Fox::ICONLIST_EXTENDEDSELECT|Fox::LAYOUT_FILL_X|Fox::LAYOUT_FILL_Y)
+
+# =========================================================================== #
+# Third tab (third tag):
+# =========================================================================== #
+@tab3 = Fox.tab_item(@tabbook, '&Buttons', nil)
+dirframe = Fox::FXHorizontalFrame.new(@tabbook, Fox::FRAME_THICK|Fox::FRAME_RAISED)
+
+splitter = Fox::FX4Splitter.new(
+  dirframe, Fox::LAYOUT_SIDE_TOP|Fox::LAYOUT_FILL_X|Fox::LAYOUT_FILL_Y|Fox::FOURSPLITTER_TRACKING
+)
+
+button1 = Fox.button(
+  splitter,
+  '&Button1',
+  nil,
+  Fox.main_application?
+)
+button1.background_colour :black
+button1.foreground_colour :tomato
+button1.pads(40) # This combines pad_right= and pad_left=.
+button1.hint = 'Button #1 can be clicked.'
+button1.on_clicked { e 'Button #1 was clicked.' }
+button1.use_this_font = FONT_TO_USE
+
+button2 = Fox.button(
+  splitter,
+  'B&utton2',
+  nil,
+  Fox.main_application?
+)
+button2.background_colour :lightblue
+button2.foreground_colour :royalblue
+button2.pads(40)
+button2.hint = 'Button #2 can be clicked.'
+button2.on_clicked { e 'Button #2 was clicked.' }
+button2.use_this_font = FONT_TO_USE
+
+Fox.horizontal_separator(window)
+Fox.status_bar(window)
+Fox.horizontal_separator(window)
+
+Fox.create_then_run

data/lib/fox_paradise/fox_classes/README.md

@@ -0,0 +1 @@
+This directory contains modifications to core fox-classes.

data/lib/fox_paradise/fox_classes/fx_app.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise/fox_classes/fx_app.rb'
+# =========================================================================== #
+module Fox
+
+class FXApp
+
+  # ========================================================================= #
+  # === create_then_run
+  #
+  # This method simply combines two other methods.
+  # ========================================================================= #
+  def create_then_run
+    create
+    run
+  end
+
+end; end

data/lib/fox_paradise/fox_classes/fx_button.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise/fox_classes/fx_button.rb'
+# =========================================================================== #
+module Fox
+
+class FXButton
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === background_colour
+  # ========================================================================= #
+  def background_colour(
+      array = [128, 128, 0]
+    )
+    if ( array.is_a?(String) or array.is_a?(Symbol) ) and
+       Colours.is_a_html_colour?(array)
+      array = Colours.html_colour_to_rgb_value(array).split(';').map {|entry| # Is initially something like "106;90;205".
+        entry.to_i
+      }
+    end
+    self.backColor = ::Fox::FXRGB(*array)
+  end; alias background_colour= background_colour # === background_colour=
+
+  # ========================================================================= #
+  # === foreground_colour
+  # ========================================================================= #
+  def foreground_colour(
+      array = [128, 128, 0]
+    )
+    if ( array.is_a?(String) or array.is_a?(Symbol) ) and
+       Colours.is_a_html_colour?(array)
+      array = Colours.html_colour_to_rgb_value(array).split(';').map {|entry| # Is initially something like "106;90;205".
+        entry.to_i
+      }
+    end
+    self.textColor = ::Fox::FXRGB(*array)
+  end; alias foreground_colour= foreground_colour # === foreground_colour=
+       alias foreground=        foreground_colour # === foreground=
+
+  # ========================================================================= #
+  # === use_this_image=
+  #
+  # This method can be used to handle images.
+  # ========================================================================= #
+  def use_this_image=(
+      image_path,
+      use_this_as_the_main_app = ::Fox.main_app?
+    )
+    dataset = File.open(image_path, 'rb').read
+    case image_path
+    # ======================================================================= #
+    # === png files
+    # ======================================================================= #
+    when /.png$/
+      self.icon = ::Fox::FXPNGIcon.new(use_this_as_the_main_app, dataset)
+    # ======================================================================= #
+    # === jpg files
+    # ======================================================================= #
+    when /.jpg$/,
+         /.jpeg$/
+      self.icon = ::Fox::FXJPGIcon.new(use_this_as_the_main_app, dataset)
+    end
+  end
+
+  # ========================================================================= #
+  # === on_clicked
+  #
+  # This is the method that will be run when the user clicks on the
+  # button, via the mouse pointer.
+  # ========================================================================= #
+  def on_clicked(&block)
+    connect(::Fox::SEL_COMMAND, &block)
+  end
+
+  # ========================================================================= #
+  # === is_a_quit_button
+  # ========================================================================= #
+  def is_a_quit_button
+    on_clicked { exit }
+  end
+
+  # ========================================================================= #
+  # === pads
+  #
+  # This refers to side-padding; the "s" stands for "side".
+  # ========================================================================= #
+  def pads(
+      pad_by_n_pixel = 10
+    )
+    self.pad_right = pad_by_n_pixel
+    self.pad_left  = pad_by_n_pixel
+  end
+
+  # ========================================================================= #
+  # === hint=
+  #
+  # This method sets up the tooltip to use.
+  # ========================================================================= #
+  def hint=(
+      i, main_app = ::Fox.main_app?
+    )
+    self.tipText = i
+    ::Fox::FXToolTip.new(main_app)
+  end; alias fancy_tooltip= hint= # === fancy-tooltip=
+
+  alias pad_right= padRight= # === pad_right=
+
+  alias pad_left=  padLeft=  # === pad_left=
+
+end
+
+
+  # ========================================================================= #
+  # === Fox.button                                               (button tag)
+  #
+  # This method can be used to create a button.
+  #
+  # The normal "vanilla" API would look like this:
+  #
+  #   FXButton.new(parent_widget,
+  #     '&Some text',
+  #     opts: FRAME_SUNKEN|FRAME_THICK
+  #   )
+  #
+  # ========================================================================= #
+  def self.button(
+      onto_which_widget = nil, # The parent widget.
+      text              = "&Hello, Fox World!",
+      options_hash      = {},
+      no_idea           = nil,
+      evidently_something_related_to_quit = :no_special_action
+    )
+    case evidently_something_related_to_quit
+    # ======================================================================= #
+    # === :pass_through
+    # ======================================================================= #
+    when :pass_through,
+         :no_special_action,
+         :default # This is also the default.
+      # ===================================================================== #
+      # In this case nothing will be done, except for setting it to 0.
+      # ===================================================================== #
+      evidently_something_related_to_quit = 0
+    # ======================================================================= #
+    # === :quit
+    # ======================================================================= #
+    when :quit
+      evidently_something_related_to_quit = ::Fox::FXApp::ID_QUIT
+    end
+    ::Fox::FXButton.new(
+      onto_which_widget,
+      text,
+      options_hash,
+      no_idea,
+      evidently_something_related_to_quit
+    )
+  end
+
+
+end

data/lib/fox_paradise/fox_classes/fx_frame.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise/fox_classes/fx_frame.rb'
+# =========================================================================== #
+module Fox
+
+class FXFrame
+
+end; end

data/lib/fox_paradise/fox_classes/fx_horizontal_frame.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise/fox_classes/fx_horizontal_frame.rb'
+# =========================================================================== #
+module Fox
+
+class FXHorizontalFrame
+
+end; end

data/lib/fox_paradise/fox_classes/fx_label.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise/fox_classes/fx_label.rb'
+# =========================================================================== #
+module Fox
+
+class FXLabel
+
+  # ========================================================================= #
+  # === use_this_font=
+  # ========================================================================= #
+  def use_this_font=(i)
+    setFont(i)
+  end; alias set_font use_this_font= # === set_font
+
+end; end

data/lib/fox_paradise/fox_classes/fx_list.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise/fox_classes/fx_list.rb'
+# =========================================================================== #
+module Fox
+
+class FXList
+
+  # ========================================================================= #
+  # === use_this_font=
+  # ========================================================================= #
+  def use_this_font=(i)
+    setFont(i)
+  end; alias set_font use_this_font= # === set_font
+
+end; end

data/lib/fox_paradise/fox_classes/fx_main_window.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Fox
+
+class FXMainWindow
+
+  # ========================================================================= #
+  # === do_show
+  # ========================================================================= #
+  def do_show(
+      i = ::Fox::PLACEMENT_SCREEN
+    )
+    show(i)
+  end
+
+  # ========================================================================= #
+  # === width_height
+  # ========================================================================= #
+  def width_height(
+      width  = 1400,
+      height = 800
+    )
+    self.width  = width
+    self.height = height
+  end
+
+end; end

data/lib/fox_paradise/toplevel_methods/misc.rb

@@ -0,0 +1,204 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise/toplevel_methods/misc.rb'
+# =========================================================================== #
+module Fox
+
+  require 'fox_paradise/fox_classes/fx_app.rb'
+  require 'fox_paradise/fox_classes/fx_button.rb'
+  require 'fox_paradise/fox_classes/fx_label.rb'
+  require 'fox_paradise/fox_classes/fx_frame.rb'
+  require 'fox_paradise/fox_classes/fx_horizontal_frame.rb'
+  require 'fox_paradise/fox_classes/fx_list.rb'
+  require 'fox_paradise/fox_classes/fx_main_window.rb'
+
+  alias e puts
+
+  # ========================================================================= #
+  # === @application_window
+  #
+  # This variable can be used to keep track of the main application
+  # window.
+  # ========================================================================= #
+  @application_window = nil
+
+  # ========================================================================= #
+  # === Fox.application_window?
+  # ========================================================================= #
+  def self.application_window?
+    @application_window
+  end; self.instance_eval { alias the_app?          application_window? } # === Fox.the_app?
+       self.instance_eval { alias main_app?         application_window? } # === Fox.main_app?
+       self.instance_eval { alias main_application? application_window? } # === Fox.main_application?
+
+  # ========================================================================= #
+  # === Fox.set_application_window
+  # ========================================================================= #
+  def self.set_application_window(i)
+    @application_window = i
+  end
+
+  # ========================================================================= #
+  # === Fox.create_then_run
+  # ========================================================================= #
+  def self.create_then_run
+    ::Fox.application_window?.create_then_run
+  end
+
+  # ========================================================================= #
+  # === Fox.run
+  # ========================================================================= #
+  def self.run(
+      this = ::Fox.application_window?
+    )
+    this.run
+  end
+
+  # ========================================================================= #
+  # === Fox.initialize_application_window
+  #
+  # This method is similar to:
+  #
+  #   app = Fox::FXApp.new
+  #
+  # ========================================================================= #
+  def self.initialize_application_window
+    @application_window = app # Call .app().
+  end
+
+  # ========================================================================= #
+  # === Fox.app
+  #
+  # This method can be used to create a new Fox-Application.
+  # ========================================================================= #
+  def self.app(
+      a = 'Hello world!',
+      b = 'FoxTest'
+    )
+    return ::Fox::FXApp.new(a, b)
+  end
+
+  # ========================================================================= #
+  # === Fox.font                                                   (font tag)
+  #
+  # Simplified toplevel-method to assign to a font. 
+  # ========================================================================= #
+  def self.font(
+      use_this_font_name         = 'Hack',
+      use_this_for_the_font_size = 20,
+      use_this_application       = Fox.main_application?
+    )
+    Fox::FXFont.new(
+      use_this_application, use_this_font_name, use_this_for_the_font_size
+    )
+  end
+
+  # ========================================================================= #
+  # === Fox.tab_item
+  # ========================================================================= #
+  def self.tab_item(
+      window,
+      text     = '&Buttons',
+      whatever = nil
+    )
+    Fox::FXTabItem.new(window, text,whatever)
+  end
+
+  # ========================================================================= #
+  # === Fox.filelist
+  # ========================================================================= #
+  def self.filelist(
+      window,
+      options = Fox::ICONLIST_EXTENDEDSELECT|Fox::LAYOUT_FILL_X|Fox::LAYOUT_FILL_Y
+    )
+    Fox::FXFileList.new(
+      window, options
+    )
+  end
+
+  # ========================================================================= #
+  # === Fox.horizontal_separator
+  #
+  # The first argument must be the parent window. This is mandatory.
+  # ========================================================================= #
+  def self.horizontal_separator(
+      window,
+      use_this_as_the_layout = Fox::LAYOUT_SIDE_TOP|Fox::LAYOUT_FILL_X|Fox::SEPARATOR_GROOVE
+    )
+    Fox::FXHorizontalSeparator.new(
+      window,
+      use_this_as_the_layout
+    )
+  end; self.instance_eval { alias hseparator horizontal_separator } # === Fox.hseparator
+
+  # ========================================================================= #
+  # === Fox.horizontal_frame                                      (frame tag)
+  #
+  # This method will create a horizontal frame.
+  # ========================================================================= #
+  def self.horizontal_frame(
+      use_this_the_main_window = nil,
+      options_to_use           = Fox::LAYOUT_SIDE_TOP|Fox::FRAME_NONE|Fox::LAYOUT_FILL_X|Fox::LAYOUT_FILL_Y|Fox::PACK_UNIFORM_WIDTH
+    )
+    Fox::FXHorizontalFrame.new(
+      use_this_the_main_window,
+      options_to_use
+    )
+  end
+
+  # ========================================================================= #
+  # === Fox.status_bar
+  #
+  # The first argument must be the parent window. This is mandatory.
+  # ========================================================================= #
+  def self.status_bar(
+      use_this_the_main_window = nil,
+      options_to_use           = Fox::LAYOUT_SIDE_BOTTOM|Fox::LAYOUT_FILL_X|Fox::STATUSBAR_WITH_DRAGCORNER
+    )
+    Fox::FXStatusBar.new(
+      use_this_the_main_window,
+      options_to_use
+    )
+  end; self.instance_eval { alias statusbar status_bar } # === Fox.statusbar
+
+  # ========================================================================= #
+  # === Fox.window
+  #
+  # Note that this method will automatically call .show() on the window.
+  # This may be subject to change at a later time (written August 2021).
+  #
+  # This is actually a "main window".
+  # ========================================================================= #
+  def self.window(
+      root       = :create_new,
+      title      = '', # This is the main window's title. It will be displayed in the window's title bar.
+      a          = nil,
+      b          = nil,
+      decor_type = Fox::DECOR_ALL
+    )
+    case title
+    when :the_filename_is_the_title
+      title = File.basename($PROGRAM_NAME) # We only need the short variant.
+    end
+    case root # case tag
+    # ======================================================================= #
+    # === :create_new
+    # ======================================================================= #
+    when :create_new
+      root = ::Fox.app
+      Fox.set_application_window(root)
+    end
+    main_window = ::Fox::FXMainWindow.new(
+      root,
+      title,
+      a,
+      b,
+      decor_type
+    )
+    main_window.show # See the explanation on top of this method.
+    return main_window
+  end
+
+end

data/lib/fox_paradise/version/version.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise/version/version.rb'
+# =========================================================================== #
+module Fox
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.0.12'
+
+end

data/lib/fox_paradise.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'fox_paradise'
+# =========================================================================== #
+require 'fox16' # This is the hardcoded version. It may change at a later moment in time.
+require 'fox_paradise/toplevel_methods/misc.rb'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: fox_paradise
+version: !ruby/object:Gem::Version
+  version: 0.0.12
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colours
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fxruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2+
+
+    This library is called fox_paradise. It bundles together code that
+    can be used for the FOX toolkit, via the fxruby bindings.
+
+    The project is very beta-ish though. Do not use it for anything
+    in production yet.
+
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- doc/README.gen
+- doc/SNIPPETS.md
+- doc/TODO.md
+- fox_paradise.gemspec
+- lib/fox_paradise.rb
+- lib/fox_paradise/admin_panel/admin_panel.rb
+- lib/fox_paradise/autoinitialize.rb
+- lib/fox_paradise/examples/001_hello_world.rb
+- lib/fox_paradise/examples/002_simple_window.rb
+- lib/fox_paradise/examples/003_tool_tip_example.rb
+- lib/fox_paradise/examples/004_show_this_image.rb
+- lib/fox_paradise/examples/005_two_buttons_in_a_resizable_panel.rb
+- lib/fox_paradise/examples/006_notebook_tab_example.rb
+- lib/fox_paradise/fox_classes/README.md
+- lib/fox_paradise/fox_classes/fx_app.rb
+- lib/fox_paradise/fox_classes/fx_button.rb
+- lib/fox_paradise/fox_classes/fx_frame.rb
+- lib/fox_paradise/fox_classes/fx_horizontal_frame.rb
+- lib/fox_paradise/fox_classes/fx_label.rb
+- lib/fox_paradise/fox_classes/fx_list.rb
+- lib/fox_paradise/fox_classes/fx_main_window.rb
+- lib/fox_paradise/toplevel_methods/misc.rb
+- lib/fox_paradise/version/version.rb
+homepage: https://rubygems.org/gems/fox_paradise
+licenses:
+- LGPL-2.1
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.25
+requirements: []
+rubygems_version: 3.2.25
+signing_key:
+specification_version: 4
+summary: This library is called fox_paradise. It bundles together code that can be
+  used for the FOX toolkit, via the fxruby bindings.  The project is very beta-ish
+  though. Do not use it for anything in production yet.
+test_files: []
+...