sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/ViewObserver.rb

@@ -0,0 +1,40 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to view events. To implement
+# this observer, create a Ruby class of this type, override the desired
+# methods, and add an instance of the observer to the view object.
+#
+# @example
+#   # This is an example of an observer that watches tool interactions.
+#   class MyViewObserver < Sketchup::ViewObserver
+#     def onViewChanged(view)
+#       puts "onViewChanged: #{view}"
+#     end
+#   end
+#
+#   # Attach the observer.
+#   Sketchup.active_model.active_view.add_observer(MyViewObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::ViewObserver
+
+  # Instance Methods
+
+  # The {#onViewChanged} method is called whenever the view is altered, such as
+  # when the user uses the Pan, Orbit, or Zoom tools are used.
+  #
+  # @example
+  #   def onViewChanged(view)
+  #     pust "onViewChanged: #{view}"
+  #   end
+  #
+  # @param [Sketchup::View] view
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onViewChanged(view)
+  end
+
+end

data/SketchUp/UI/Command.rb

@@ -0,0 +1,307 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Command class is the preferred class for adding tools to the menus and
+# Ruby toolbars. For example, you could add a menu item and pass it a code
+# block directly, or you could first create a Command.
+#
+# Using Commands gives you greater control over how the item works in the UI,
+# and it allows multiple spots in the UI to call the same code. For example,
+# You might want a toolbar button and a context-click menu item to both point
+# to the same command, and to control the tooltip and its "graying" from
+# a single spot in your code.
+#
+# @example
+#   # You can add menu items as procedure blocks, as shown here, but
+#   # you have no control over whether it is grayed out, for example.
+#   UI.menu("Draw").add_item("My Procedure") {
+#     UI.messagebox("My Procedure")
+#   }
+#
+#   # Better to create a command object.
+#   cmd = UI::Command.new("Tester") {
+#     UI.messagebox("My Command")
+#   }
+#   cmd.menu_text = "My Command"
+#   cmd.set_validation_proc {
+#     if Sketchup.active_model.selection.length == 0
+#       MF_GRAYED
+#     else
+#       MF_ENABLED
+#     end
+#   }
+#   UI.menu("Draw").add_item cmd
+#
+# @version SketchUp 6.0
+class UI::Command
+
+  # Class Methods
+
+  # The new method is used to create a new command.
+  #
+  # @example
+  #   UI.menu("Draw").add_separator
+  #
+  #   # Adds a Test submenu to the Draw menu where the Tester menu item appears
+  #   testmenu = UI.menu("Draw").add_submenu("Test")
+  #
+  #   # This menu item simply displays Hello World on the screen when clicked.
+  #   cmd = UI::Command.new("Tester") { UI.messagebox("Hello World") }
+  #   testmenu.add_item cmd
+  #
+  # @param menutext
+  #   The text that will appear for this command's menu item
+  #   if it appears on a menu.
+  #
+  # @return command - the new Command object
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield Code that executes the command when the menu item or
+  #   toolbar item is selected.
+  def self.new(menutext)
+  end
+
+  # Instance Methods
+
+  # The large_icon method returns the icon file for the command's
+  # large icon.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This command displays Hello World on the screen when clicked
+  #   cmd = UI::Command.new("Test") { UI.messagebox("Hello World") }
+  #   cmd.small_icon = "ToolPencilSmall.png"
+  #   cmd.large_icon = "ToolPencilLarge.png"
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #   puts cmd.large_icon
+  #
+  # @return string - the path to the large icon.
+  #
+  # @version SketchUp 8.0 M1
+  def large_icon
+  end
+
+  # The large_icon= method is used to identify the icon file for the command's
+  # large icon. large icons should be 24x24 pixel images for best display
+  # quality.
+  #
+  # Since SketchUp 2016 it is possible to provide vector images for the cursors.
+  # SVG format for Windows and PDF format for OS X. Since the vector images scale
+  # for both small and large icon sizes, you may choose to use only one vector
+  # image for both variants.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This command displays Hello World on the screen when clicked
+  #   cmd = UI::Command.new("Test") { UI.messagebox("Hello World") }
+  #   cmd.small_icon = "ToolPencilSmall.png"
+  #   cmd.large_icon = "ToolPencilLarge.png"
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #
+  # @param path
+  #   The path to the large icon.
+  #
+  # @return command - the Command object
+  #
+  # @version SketchUp 6.0
+  def large_icon=(path)
+  end
+
+  # The menu_text method returns the menu item name for the command.
+  #
+  # @example
+  #   add_separator_to_menu("Draw")
+  #   # Adds a Test submenu to the Draw menu where the Tester menu item appears
+  #   testmenu = UI.menu("Draw").add_submenu("Test")
+  #   cmd = UI::Command.new("Tester") { UI.messagebox("Hello World") }
+  #   cmd.menu_text = "New String"
+  #   testmenu.add_item cmd
+  #   puts cmd.menu_text
+  #
+  # @return command - a Command object
+  #
+  # @version SketchUp 8.0 M1
+  def menu_text
+  end
+
+  # The menu_text= method is used to set the menu item name for the command.
+  #
+  # @example
+  #   add_separator_to_menu("Draw")
+  #   # Adds a Test submenu to the Draw menu where the Tester menu item appears
+  #   testmenu = UI.menu("Draw").add_submenu("Test")
+  #   cmd = UI::Command.new("Tester") { UI.messagebox("Hello World") }
+  #   cmd.menu_text = "New String"
+  #   testmenu.add_item cmd
+  #
+  # @param menuitem
+  #   A string representing the menu item for the command.
+  #
+  # @return command - a Command object
+  #
+  # @version SketchUp 6.0
+  def menu_text=(menuitem)
+  end
+
+  # The {#set_validation_proc} method allows you to change whether the command
+  # is enabled, checked, etc. based on the user state. For example, you might
+  # want your command to be disabled unless the user has a current selection.
+  #
+  # @example
+  #   # Create a command object.
+  #   cmd = UI::Command.new("Tester") {
+  #     UI.messagebox("My Command")
+  #   }
+  #   cmd.menu_text = "My Command"
+  #   cmd.set_validation_proc {
+  #     if Sketchup.active_model.selection.length == 0
+  #       MF_GRAYED
+  #     else
+  #       MF_ENABLED
+  #     end
+  #   }
+  #   UI.menu("Draw").add_item(cmd)
+  #
+  # @return [UI::Command]
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield []
+  #
+  # @yieldreturn [Integer] +MF_ENABLED+, +MF_DISABLED+, +MF_CHECKED+,
+  #   +MF_UNCHECKED+, or +MF_GRAYED+
+  def set_validation_proc
+  end
+
+  # The small_icon method returns the icon file for the command's
+  # small icon.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This toolbar command displays Hello World on the screen when clicked.
+  #   cmd = UI::Command.new("Tester") { UI.messagebox("Hello World") }
+  #   cmd.small_icon = "ToolPencilSmall.png"
+  #   cmd.large_icon = "ToolPencilLarge.png"
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #   puts cmd.small_icon
+  #
+  # @return string - the path to the small_icon
+  #
+  # @version SketchUp 8.0 M1
+  def small_icon
+  end
+
+  # The small_icon= method is used to identify the icon file for the command's
+  # small icon. Small icons should be 16x16 pixel images for best display
+  # quality.
+  #
+  # Since SketchUp 2016 it is possible to provide vector images for the cursors.
+  # SVG format for Windows and PDF format for OS X. Since the vector images scale
+  # for both small and large icon sizes, you may choose to use only one vector
+  # image for both variants.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This toolbar command displays Hello World on the screen when clicked.
+  #   cmd = UI::Command.new("Tester") { UI.messagebox("Hello World") }
+  #   cmd.small_icon = "ToolPencilSmall.png"
+  #   cmd.large_icon = "ToolPencilLarge.png"
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #
+  # @param path
+  #   A path to the small icon.
+  #
+  # @return command - the Command object
+  #
+  # @version SketchUp 6.0
+  def small_icon=(path)
+  end
+
+  # The status_bar_text method returns the status bar text for the
+  # command.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This toolbar tool simply displays Hello World on the screen
+  #   # when clicked
+  #   cmd = UI::Command.new("Tester") { UI.messagebox("Hello World") }
+  #   cmd.small_icon = "ToolPencilSmall.png"
+  #   cmd.large_icon = "ToolPencilLarge.png"
+  #   cmd.status_bar_text = $tStrings.GetString("Testing the toolbars class")
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #   puts cmd.status_bar_text
+  #
+  # @return string - the status bar text.
+  #
+  # @version SketchUp 8.0 M1
+  def status_bar_text
+  end
+
+  # The status_bar_text= method is used to set the status bar text for the
+  # command.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This toolbar tool simply displays Hello World on the screen when clicked
+  #   cmd = UI::Command.new("Tester") { UI.messagebox("Hello World") }
+  #   cmd.small_icon = "ToolPencilSmall.png"
+  #   cmd.large_icon = "ToolPencilLarge.png"
+  #   cmd.status_bar_text = $tStrings.GetString("Testing the toolbars class")
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #
+  # @param text
+  #   The text that will appear on the status bar when the
+  #   cursor is over the command's menu item.
+  #
+  # @return command - the Command object
+  #
+  # @version SketchUp 6.0
+  def status_bar_text=(text)
+  end
+
+  # The tooltip method returns command item's tooltip text.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This command displays Hello World on the screen when clicked
+  #   cmd = UI::Command.new("Test") { UI.messagebox("Hello World") }
+  #   cmd.tooltip = "Hello World Tool"
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #   puts cmd.tooltip
+  #
+  # @return string - the tooltip text
+  #
+  # @version SketchUp 8.0 M1
+  def tooltip
+  end
+
+  # The tooltip= method is used to define a command item's tooltip text. Tooltips
+  # will appear when the command is attached to a tool bar and the user hovers
+  # their cursor over the icon.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This command displays Hello World on the screen when clicked
+  #   cmd = UI::Command.new("Test") { UI.messagebox("Hello World") }
+  #   cmd.tooltip = "Hello World Tool"
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #
+  # @param text
+  #   The text of the tooltip.
+  #
+  # @return command - the Command object
+  #
+  # @version SketchUp 6.0
+  def tooltip=(text)
+  end
+
+end

data/SketchUp/UI/HtmlDialog.rb

@@ -0,0 +1,346 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Ruby HtmlDialog class allows you to create and interact with HTML dialog
+# boxes from Ruby. This is the best way to generate complex, embedded UIs
+# inside SketchUp, but it does generally require HTML and JavaScript expertise.
+#
+# If your goal is to simple display a website to your users, consider using
+# {UI#openURL}, which will show them a web page in their default browser rather
+# than inside a dialog in SketchUp.
+#
+# @version SketchUp 2017
+class UI::HtmlDialog
+
+  # Constants
+
+  STYLE_DIALOG = nil # Stub value.
+  STYLE_UTILITY = nil # Stub value.
+  STYLE_WINDOW = nil # Stub value.
+
+  # Instance Methods
+
+  # The {#add_action_callback} method establishes a Ruby callback method that your
+  # html dialog can call to perform some function.
+  #
+  # Use the +sketchup.callback_method_name+ to invoke the callback method from your
+  # html dialog. Your JavaScript in the html dialog will invoke the callback with
+  # the same number of arguments.
+  #
+  # The call is asynchronous. JavaScript call might return before Ruby callback
+  # even called. Use +onCompleted+ callback to get notified for completion.
+  #
+  # Basic types such as booleans, numbers, strings, arrays and hashes are
+  # automatically converted between Ruby and JavaScript.
+  #
+  # @example JavaScript with callback
+  #   sketchup.say('Hello World', 42, {
+  #     onCompleted: function() {
+  #       console.log('Ruby side done.');
+  #     }
+  #   });
+  #
+  # @example Ruby Code
+  #   dialog.add_action_callback("say") { |action_context, param1, param2|
+  #     puts "JavaScript said #{param1} and #{param2}"
+  #   }
+  #
+  # @example JavaScript
+  #   sketchup.say('Hello World', 42);
+  #
+  # @param [String] callback_name
+  #   The name of the callback method to be
+  #   invoked from the html dialog.
+  #
+  # @return [Boolean] true if action added successfully, false
+  #   otherwise.
+  #
+  # @version SketchUp 2017
+  #
+  # @yield [action_context, ...]
+  #
+  # @yieldparam [Object] action_context
+  #   action_context  Currently unused.
+  #
+  # @yieldparam [Object] ...
+  #   The parameters sent from JavaScript.
+  def add_action_callback(callback_name)
+  end
+
+  # The {#bring_to_front} method is used to bring the window to the front,
+  # putting it on top of other windows even if its minimized.
+  #
+  # @example
+  #   dialog.bring_to_front
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def bring_to_front
+  end
+
+  # The {#center} method is used to center the HtmlDialog relative to the active
+  # model window. If there is no active model window, this function doesn't do
+  # anything.
+  #
+  # @example
+  #   dialog.center
+  #
+  # @return [true]
+  #
+  # @version SketchUp 2017
+  def center
+  end
+
+  # The {#close} method is used to close a dialog box.
+  #
+  # @example
+  #   dialog.close
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def close
+  end
+
+  # The {#execute_script} method is used to execute a JavaScript string on the
+  # html dialog asynchronously.
+  #
+  # @example
+  #   js_command = "document.getElementById('id').innerHTML = '<b>Hi!</b>'"
+  #   dialog.execute_script(js_command)
+  #
+  # @param [String] script
+  #   The JavaScript script to execute on the HtmlDialog.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def execute_script(script)
+  end
+
+  # The new method is used to create a new HtmlDialog.
+  #
+  # The +properties+ hash accepts an optional key +style+ where the value is
+  # one of:
+  #
+  # [+UI::HtmlDialog::STYLE_DIALOG+]   HtmlDialog stays at the top of SketchUp.
+  #
+  # [+UI::HtmlDialog::STYLE_WINDOW+]   HtmlDialog can go behind SketchUp and
+  #                                    doesn't disappear when SketchUp looses
+  #                                    focus.
+  #
+  # [+UI::HtmlDialog::STYLE_UTILITY+]  HtmlDialog is shown with small titlebar
+  #                                    and stays on top of SketchUp.
+  #
+  # @example
+  #   dialog = UI::HtmlDialog.new(
+  #   {
+  #     :dialog_title => "Dialog Example",
+  #     :preferences_key => "com.sample.plugin",
+  #     :scrollable => true,
+  #     :resizable => true,
+  #     :width => 600,
+  #     :height => 400,
+  #     :left => 100,
+  #     :top => 100,
+  #     :min_width => 50,
+  #     :min_height => 50,
+  #     :max_width =>1000,
+  #     :max_height => 1000,
+  #     :style => UI::HtmlDialog::STYLE_DIALOG
+  #   })
+  #   dialog.set_url("http://www.sketchup.com")
+  #   dialog.show
+  #
+  # @option properties [Integer] :width (250)
+  #
+  # @option properties [Integer] :max_height (-1)
+  #
+  # @option properties [String] :dialog_title
+  #
+  # @option properties [String] :preferences_key
+  #
+  # @option properties [Boolean] :scrollable
+  #
+  # @option properties [Boolean] :resizable (true)
+  #
+  # @option properties [Integer] :height (250)
+  #
+  # @option properties [Integer] :max_width (-1)
+  #
+  # @option properties [Integer] :left (0)
+  #
+  # @option properties [Integer] :top (0)
+  #
+  # @option properties [Integer] :min_width (0)
+  #
+  # @option properties [Integer] :min_height (0)
+  #
+  # @option properties [Integer] :style (UI::HtmlDialog::STYLE_DIALOG)
+  #
+  # @param [Hash] properties
+  #   A hash containing the initial properties of
+  #   the newly created dialog.
+  #
+  # @return [HtmlDialog]
+  #
+  # @version SketchUp 2017
+  def initialize(properties)
+  end
+
+  # The {#set_can_close} method is used to attach a block that is executed just
+  # before closing, this block has to return a boolean, if the block returns
+  # false the close will be canceled.
+  #
+  # @example
+  #   dialog.set_can_close { false }
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  #
+  # @yieldreturn [Boolean] Return a boolean to indicate if the dialogs should
+  #   close.
+  def set_can_close
+  end
+
+  # The {#set_file} method is used to identify a local HTML file to display in the
+  # HtmlDialog.
+  #
+  # @example
+  #   dialog.set_file("c:/mypage.html")
+  #
+  # @param [String] filename
+  #   The filename for the HtmlDialog file (HTML file)
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def set_file(filename)
+  end
+
+  # The {#set_html} method is used to load a HtmlDialog with a string of provided
+  # HTML.
+  #
+  # @example
+  #   html = '<b>Hello world!</b>'
+  #   dialog.set_html(html)
+  #
+  # @param [String] html_string
+  #   A string of valid html to display in your
+  #   HtmlDialog.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def set_html(html_string)
+  end
+
+  # The {#set_on_closed} method is used to attach a block that will be
+  # executed when a dialog is already in the process of closing, do any last
+  # minute operations within this block such as saving the current state.
+  #
+  # @example
+  #   dialog.set_on_closed { save_selection }
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def set_on_closed
+  end
+
+  # The {#set_position} method is used to set the position of the HtmlDialog
+  # relative to the screen, in pixels.
+  #
+  # @example
+  #   dialog.set_position(100, 50)
+  #
+  # @param [Integer] left
+  #   The number of pixels from the left.
+  #
+  # @param [Integer] top
+  #   The number of pixels from the top of the screen.
+  #
+  # @return [true]
+  #
+  # @version SketchUp 2017
+  def set_position(left, top)
+  end
+
+  # The {#set_size} method is used to set the size of the HtmlDialog, in pixels.
+  #
+  # @example
+  #   dialog.set_size(320, 240)
+  #
+  # @param [Integer] width
+  #   Width of the HtmlDialog.
+  #
+  # @param [Integer] height
+  #   Height of the HtmlDialog.
+  #
+  # @return [true]
+  #
+  # @version SketchUp 2017
+  def set_size(width, height)
+  end
+
+  # The {#set_url} method is used to load a HtmlDialog with the content at a
+  # specific URL. This method allows you to load web sites in a HtmlDialog.
+  #
+  # @example
+  #   dialog.set_url("http://www.sketchup.com")
+  #
+  # @param [String] url
+  #   The URL for a specific web site.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def set_url(url)
+  end
+
+  # The {#show} method is used to display a non-modal dialog box.
+  #
+  # @example
+  #   dialog.show
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def show
+  end
+
+  # The {#show_modal} method is used to display a modal dialog box.
+  #
+  # @example
+  #   dialog.show_modal
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def show_modal
+  end
+
+  # The {#visible?} method is useful to tell if the dialog is shown and still
+  # alive, if the dialog is minimized or not visible on the screen this will
+  # still return +true+.
+  #
+  # @example
+  #   if dialog.visible?
+  #     dialog.bring_to_front
+  #   else
+  #     dialog = UI::HtmlDialog.new
+  #     dialog.set_url("http://www.sketchup.com")
+  #     dialog.show
+  #   end
+  #
+  # @return [Boolean] Returns true if the dialog is open.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def visible?
+  end
+
+end