pdf_paradise 0.3.20

data/lib/pdf_paradise/gui/universal_widgets/convert_pdf_to_text/convert_pdf_to_text.rb

@@ -0,0 +1,366 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::UniversalWidgets::ConvertPdfToText
+#
+# Usage example:
+#
+#   PdfParadise::GUI::UniversalWidgets::ConvertPdfToText.new(ARGV)
+#
+# =========================================================================== #
+# require 'pdf_paradise/gui/universal_widgets/convert_pdf_to_text/convert_pdf_to_text.rb'
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+module GUI
+
+module UniversalWidgets
+
+class ConvertPdfToText < ::PdfParadise::Base # === PdfParadise::GUI::UniversalWidgets::ConvertPdfToText
+
+  require 'universal_widgets/base_module/base_module.rb'
+  include ::UniversalWidgets::BaseModule
+
+  require 'pdf_paradise/utility_scripts/convert_pdf_to_text.rb'
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Convert .pdf to text-file'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '60% or minimum 1340px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '30% or minimum 880px'
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = :hack_23
+
+  # ========================================================================= #
+  # === LARGER_FONT
+  # ========================================================================= #
+  LARGER_FONT   = :hack_25
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  # ========================================================================= #
+  SMALLER_FONT  = :hack_20
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    determine_the_GUI_to_be_used(commandline_arguments) # This must come first, even before reset().
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    on_delete_event_quit_the_application
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super() if respond_to?(:super)
+    reset_the_shared_module # This can come early.
+    reset_the_base_module
+    reset_the_internal_variables
+    infer_the_namespace
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, namespace?]
+    # ======================================================================= #
+    # === Set the title, width, height and the font in use.
+    # ======================================================================= #
+    title_width_height_font(TITLE, WIDTH, HEIGHT, USE_THIS_FONT)
+    if use_gtk3?
+      handle_CSS_rules
+    end
+    infer_the_size_automatically
+  end
+
+  # ========================================================================= #
+  # === smaller_font?
+  # ========================================================================= #
+  def smaller_font?
+    SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === handle_CSS_rules                                            (CSS tag)
+  # ========================================================================= #
+  def handle_CSS_rules
+    use_gtk_paradise_project_css_file
+    append_project_css_file
+    more_CSS_then_apply_it '
+
+.small_border { border: 2px solid steelblue; }
+
+'
+  end
+
+  # ========================================================================= #
+  # === reset_the_shared_module
+  #
+  # This method can be used for ruby-gtk3 and ruby-libui, among other
+  # toolkits.
+  # ========================================================================= #
+  def reset_the_shared_module
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    2
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === do_open_a_local_pdf_file
+  # ========================================================================= #
+  def do_open_a_local_pdf_file
+    # ======================================================================= #
+    # Create the particular file-chooser widget that we wish to use.
+    # ======================================================================= #
+    create_a_new_file_chooser_dialog(self) {{
+      start_dir:               return_pwd,
+      filter_for:              :pdf_files,
+      additional_directories:  '/Depot/PDF/'
+    }}
+    _ = ::Gtk.main_file?
+    set_filepath(_)
+    do_the_conversion
+  end
+
+  # ========================================================================= #
+  # === set_filepath
+  # ========================================================================= #
+  def set_filepath(i)
+    @entry_convert_pdf_to_text.set_text(i.to_s)
+  end
+
+  # ========================================================================= #
+  # === do_the_conversion                       (conversion tag, convert tag)
+  #
+  # This is the method that will do the actual conversion.
+  # ========================================================================= #
+  def do_the_conversion
+    _ = @entry_convert_pdf_to_text.text?
+    if _ and File.exist?(_)
+      result = PdfParadise::ConvertPdfToText.new(_)
+      output_file = result.output_file?
+      if File.exist?(output_file)
+        # =================================================================== #
+        # Assign it as the new text-buffer next:
+        # =================================================================== #
+        @text_buffer.set_text(
+          File.read(output_file, encoding: 'UTF-8').to_s
+        )
+      end
+    else
+      popover(
+        'Please specify a local, existing .pdf file.',
+        use_this_widget: @entry_convert_pdf_to_text,
+        font_to_use: :hack_20
+      ).popup
+    end
+  end
+
+  # ========================================================================= #
+  # === do_all_startup_related_actions
+  # ========================================================================= #
+  def do_all_startup_related_actions
+  end
+
+  # ========================================================================= #
+  # === connect_the_skeleton                                    (connect tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    outer_vbox = create_vbox
+
+    hbox = create_hbox
+    hbox.minimal(
+      text('Convert this <b>.pdf</b> file to text:'), 4
+    )
+    hbox.minimal(@entry_convert_pdf_to_text,      5)
+    hbox.minimal(return_the_open_pdf_file_button, 4)
+    outer_vbox.minimal(hbox, 2)
+    tiny_hbox = create_hbox
+    tiny_hbox.minimal(@button_do_the_conversion, 10)
+    outer_vbox.minimal(tiny_hbox, 2)
+    outer_vbox.minimal(@scrolled_window,         5)
+
+    window = create_window_or_runner(nil, width?, height?, title?)
+    window << outer_vbox
+
+    properly_prepare_this_window(window,
+      {
+        title:       title?,
+        font:        font?,
+        width:       width?,
+        height:      height?,
+        padding:     padding?,
+        border_size: border_size?
+      }
+    )
+    window.show_all
+    window.top_left
+    do_all_startup_related_actions
+    run_main
+  end
+
+  # ========================================================================= #
+  # === create_the_skeleton                        (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    create_the_entry
+    create_the_buttons
+    create_the_scrolled_window_with_the_text_buffer
+  end
+
+  # ========================================================================= #
+  # === return_the_open_pdf_file_button
+  # ========================================================================= #
+  def return_the_open_pdf_file_button
+    @button_open_pdf_file
+  end
+
+  # ========================================================================= #
+  # === create_the_entry
+  # ========================================================================= #
+  def create_the_entry
+    # ======================================================================= #
+    # === @entry_convert_pdf_to_text
+    # ======================================================================= #
+    @entry_convert_pdf_to_text = create_entry
+    @entry_convert_pdf_to_text.width_height(600, 42)
+    @entry_convert_pdf_to_text.yellow_background
+    @entry_convert_pdf_to_text.set_text(
+      '/Depot/PDF/foobar.pdf'
+    )
+    @entry_convert_pdf_to_text.enable_scroll_events
+    # ======================================================================= #
+    # Let this entry respond to mouse-scroll-events, e. g. the user does
+    # some scrolling via the mouse-wheel.
+    # ======================================================================= #
+    @entry_convert_pdf_to_text.on_mouse_scroll_event {|widget, event|
+      this_file = @entry_convert_pdf_to_text.text?
+      base_dir = "#{File.dirname(this_file)}/"
+      array_pdf_entries = Dir[base_dir+'*.pdf']
+      # ===================================================================== #
+      # Next, determine the position.
+      # ===================================================================== #
+      index = array_pdf_entries.index(this_file)
+      if index
+        if scroll_up?(event) # Scroll up.
+          index -= 1 unless index == 0
+        elsif scroll_down?(event) # Scroll down.
+          index += 1 unless index >= (array_pdf_entries.size - 1)
+        end
+        this_file = array_pdf_entries[index]
+        @entry_convert_pdf_to_text.set_text(this_file)
+      end
+    }
+  end
+
+
+  # ========================================================================= #
+  # === create_the_scrolled_window_with_the_text_buffer
+  # ========================================================================= #
+  def create_the_scrolled_window_with_the_text_buffer
+    @text_buffer = create_text_buffer
+    text_view    = create_text_view(@text_buffer)
+    @scrolled_window = create_scrolled_window(text_view) { :always }
+    @scrolled_window.width_height(600, 560)
+    @scrolled_window.bblack1
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons                          (buttons tag, button tag)
+  # ========================================================================= #
+  def create_the_buttons
+    # ======================================================================= #
+    # === Create the open-file-button
+    # ======================================================================= #
+    @button_open_pdf_file = create_button('_Open File', self, :use_mnemonics) {
+      :do_open_a_local_pdf_file
+    }
+    @button_open_pdf_file.pad5px
+    @button_open_pdf_file.hint = 'Click on this button '\
+      'in order to open a local .pdf file.'
+    # ======================================================================= #
+    # === button_do_the_conversion
+    # ======================================================================= #
+    @button_do_the_conversion = create_button('_Convert', self, :use_mnemonics) {
+      :do_the_conversion
+    }
+    @button_do_the_conversion.clear_background
+    @button_do_the_conversion.on_hover(:lightblue)
+    @button_do_the_conversion.bblack1
+    @button_do_the_conversion.pad5px
+    @button_do_the_conversion.hint = 'Click this button '\
+      'to <b>convert the .pdf file into a text-file</b>.'
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::UniversalWidgets::ConvertPdfToText.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/run'
+    _ = ::PdfParadise::GUI::Gtk::ConvertPdfToText.new(i)
+    r = ::Gtk.run
+    _.set_parent_widget(r) # Must come before we enable the key-combinations.
+    r << _
+    r.automatic_size_then_automatic_title
+    r.enable_quick_exit
+    r.set_background :white
+    r.maximize
+    r.top_left_then_run
+  end; self.instance_eval { alias start_gui_application run } # === Roebe::GUI::Gtk::ConvertPdfToText.start_gui_application
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::UniversalWidgets::ConvertPdfToText[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::GUI::UniversalWidgets::ConvertPdfToText.new(ARGV)
+end # guishell