sketchup-api-stubs 0.1.0

data/SketchUp/sketchupextension.rb

@@ -0,0 +1,355 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The SketchupExtension class contains methods allowing you to create and
+# manipulate SketchUp extensions. Extensions are Ruby scripts that can be
+# loaded and unloaded using the Extension manager (Extensions panel of the
+# Preferences dialog box). Generally you should register your ruby scripts as
+# an extension to give SketchUp users the ability to disable it through the
+# user interface.
+#
+# The idea here is to take the ruby script that actually creates your
+# functionality and place it in a folder somewhere outside of the /Plugins
+# folder, most commonly a subdirectory like /Plugins/MyExtension. Then
+# you create a new ruby script inside the /Plugins directory that will
+# set up the extension entry and load your original script if the user
+# has your extension turned on.
+#
+# Here is an example extension loading script. For this example, the
+# following code would be saved in /Plugins/StairTools.rb, and the
+# actual plugin itself would live in /Plugins/StairTools/core.rb.
+#
+# You can find two example extensions that ship with SketchUp,
+# su_dynamiccomponents.rb and su_sandboxtools.rb, under the /Plugins/ folder.
+#
+# @example
+#   # Create an entry in the Extension list that loads a script called
+#   # core.rb.
+#   require 'sketchup.rb'
+#   require 'extensions.rb'
+#
+#   stair_extension = SketchupExtension.new('Stair Tools", "StairTools/core.rb')
+#   stair_extension.version = '1.0'
+#   stair_extension.description = 'Tools to draw stairs automatically.'
+#   Sketchup.register_extension(stair_extension, true)
+#
+# @version SketchUp 6.0
+class SketchupExtension
+
+  # Instance Methods
+
+  # Loads the extension, meaning the underlying ruby script is immediately
+  # interpreted. This is the equivalent of checking the extension's checkbox
+  # in the Preferences > Extensions list.
+  #
+  # @example
+  #   # This will register the extension, a necessary step for it to appear
+  #   # in SketchUp's Preferences > Extensions list
+  #   ext_c = SketchupExtension.new('Stair Tools C', 'StairTools/core.rb')
+  #   Sketchup.register_extension(ext_c, false)
+  #
+  #   # And this will load the extension.
+  #   ext_c.check
+  #
+  # @return boolean - whether the load succeeded
+  #
+  # @version SketchUp 8.0 M2
+  def check
+  end
+
+  # The copyright method returns the copyright string which appears beneath
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.copyright = '2008'
+  #   copyright = extension.copyright
+  #
+  # @return copyright - the Extension copyright
+  #
+  # @version SketchUp 6.0
+  def copyright
+  end
+
+  # The copyright= method sets the copyright string which appears beneath
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.copyright = '2008'
+  #   copyright = extension.copyright
+  #
+  # @param copyright
+  #   The copyright to set
+  #
+  # @return copyright - the new copyright
+  #
+  # @version SketchUp 6.0
+  def copyright=(copyright)
+  end
+
+  # The creator method returns the creator string which appears beneath
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.creator = 'Trimble Navigation, Inc.'
+  #   creator = extension.creator
+  #
+  # @return creator - the Extension creator
+  #
+  # @version SketchUp 6.0
+  def creator
+  end
+
+  # The creator= method sets the creator string which appears beneath
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.creator = 'Trimble Navigation, Inc.'
+  #   creator = extension.creator
+  #
+  # @param creator
+  #   The creator to set
+  #
+  # @return creator - the new creator
+  #
+  # @version SketchUp 6.0
+  def creator=(creator)
+  end
+
+  # The description method returns the long description which appears beneath
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.description = 'My description.'
+  #   description = extension.description
+  #
+  # @return description - the Extension description
+  #
+  # @version SketchUp 6.0
+  def description
+  end
+
+  # The description= method sets the long description which appears beneath
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.description = 'My description.'
+  #   description = extension.description
+  #
+  # @param description
+  #   The description string to set.
+  #
+  # @return description - the Extension description
+  #
+  # @version SketchUp 6.0
+  def description=(description)
+  end
+
+  # The extension_path method returns the file system path to the extension's
+  # outer rb file.
+  #
+  # @return extension_path - the file system path to the extension
+  #
+  # @version SketchUp 2013
+  def extension_path
+  end
+
+  # The id method returns the Extension Warehouse ID string.
+  #
+  # @return id - the Extension Warehouse ID
+  #
+  # @version SketchUp 2013
+  def id
+  end
+
+  # The new method is used to create a new SketchupExtension object. Note
+  # that once the extension object is created, it will not appear in the
+  # Extension Manager dialog until your register it with the
+  # Sketchup.register_extension method.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #
+  #   # Then be sure to register it. By passing a 2nd param of true, you're
+  #   # telling SketchUp to load the extension by default.
+  #   Sketchup.register_extension(extension, true)
+  #
+  # @param title
+  #   The name of the extension
+  #
+  # @param path
+  #   The relative path to the script that loads your
+  #   plugin.
+  #
+  # @return extension - the new Extension object
+  #
+  # @version SketchUp 6.0
+  def initialize(title, path)
+  end
+
+  # Returns whether the extension is set to load when SketchUp starts up.
+  #
+  # @example
+  #   ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   UI.messagebox("load_on_start? is false: #{ext.load_on_start?.to_s}")
+  #   Sketchup.register_extension(ext, true)
+  #   UI.messagebox("load_on_start? is now true: #{ext.load_on_start?.to_s}")
+  #
+  # @return boolean - true if the extension loads on startup.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 8.0 M2
+  def load_on_start?
+  end
+
+  # Returns whether the extension is currently loaded, meaning the actual ruby
+  # script that implements the extension has been evaluated.
+  #
+  # @example
+  #   ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   UI.messagebox("loaded? is false: #{ext.loaded?.to_s}")
+  #   Sketchup.register_extension ext, true
+  #   UI.messagebox("loaded? is now true: #{ext.loaded?.to_s}")
+  #
+  # @return boolean - true if the extension has been loaded
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 8.0 M2
+  def loaded?
+  end
+
+  # The name method returns the name which appears for
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   name = extension.name
+  #
+  # @return name - the Extension name
+  #
+  # @version SketchUp 6.0
+  def name
+  end
+
+  # The name= method sets the name which appears for
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.name = 'Renamed Stair Tools'
+  #
+  # @param name
+  #   The new name
+  #
+  # @return name - the Extension name
+  #
+  # @version SketchUp 6.0
+  def name=(name)
+  end
+
+  # Returns whether the extension has been registered via
+  # Sketchup.register_extension.
+  #
+  # @example
+  #   ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   UI.messagebox("My registered? is false: #{ext.registered?.to_s}")
+  #   Sketchup.register_extension(ext, true)
+  #   UI.messagebox("Now registered? is now true: #{ext.registered?.to_s}")
+  #
+  # @return boolean - true if the extension has been registered.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 8.0 M2
+  def registered?
+  end
+
+  # Unloads the extension. This is the equivalent of unchecking the extension's
+  # checkbox in the Preferences > Extensions list.
+  #
+  # Note that technically the extension is not "unloaded" in the sense that it
+  # stops running during the current SketchUp session, but the next time the
+  # user restarts SketchUp, the extension will not be active.
+  #
+  # @example
+  #   # This unloads all extensions. The next time SketchUp starts, none of
+  #   # the extensions will be active.
+  #   Sketchup.extensions.each { |extension|
+  #     extension.uncheck
+  #   }
+  #
+  # @return boolean - whether the unload succeeded
+  #
+  # @version SketchUp 8.0 M2
+  def uncheck
+  end
+
+  # The version method returns the version which appears beneath
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.version = '5.0'
+  #   version = extension.version
+  #
+  # @return version - the Extension version
+  #
+  # @version SketchUp 6.0
+  def version
+  end
+
+  # The version method sets the version which appears beneath
+  # an extension inside the Extensions Manager dialog.
+  #
+  # @example
+  #   # Create an entry in the Extension list that loads a script called
+  #   # core.rb.
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension.version = '5.0'
+  #   version = extension.version
+  #
+  # @param version
+  #   The version string to set.
+  #
+  # @return version - the Extension version
+  #
+  # @version SketchUp 6.0
+  def version=(version)
+  end
+
+  # The version_id method returns the Extension Warehouse Version ID string.
+  #
+  # @return version_id - the Extension Warehouse Version ID string
+  #
+  # @version SketchUp 2013
+  def version_id
+  end
+
+end

data/SketchUp/string.rb

@@ -0,0 +1,24 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The String class contains a method used to parse a string as a length value.
+# All string arguments in Ruby API expect utf-8 strings.
+#
+# @version SketchUp 6.0
+class String
+
+  # Instance Methods
+
+  # The to_l method is used to convert a string to a length. The returned length
+  # is expressed in the Model units.
+  #
+  # @example
+  #   length = "5'".to_l
+  #
+  # @return length - the length value
+  #
+  # @version SketchUp 6.0
+  def to_l
+  end
+
+end

data/SketchUp/ui.rb

@@ -0,0 +1,637 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The UI module contains a number of methods for creating simple UI elements
+# from a SketchUp Ruby script.
+#
+# @version SketchUp 6.0
+module UI
+
+  # Class Methods
+
+  # The add_context_menu_handler method is used to register a block of code with
+  # SketchUp that will be called when a context menu is to be displayed. The
+  # context menu handler can then display the context menu with the items that
+  # you have added.
+  #
+  # Be careful with what you do in a context menu handler. If you perform an
+  # operation takes take a long time, such as traversing the model or selection
+  # in a large model it will delay the menu.
+  #
+  # See the contextmenu.rb script in the Plugins/examples directory for an
+  # example.
+  #
+  # @example
+  #   # Right click on anything to see a Hello World item.
+  #   UI.add_context_menu_handler do |context_menu|
+  #     context_menu.add_item("Hello World") {
+  #       UI.messagebox("Hello world")
+  #     }
+  #   end
+  #
+  # @return count - the number of context handlers that are
+  #   registered
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [menu] A block of code that takes a menu as its only as its
+  #   only argument.
+  def self.add_context_menu_handler
+  end
+
+  # The beep method plays a system beep sound.
+  #
+  # The beep method does not accept any arguments nor return any values.
+  #
+  # @example
+  #   UI.beep
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def self.beep
+  end
+
+  # The create_cursor method is used to create a cursor from an image file at
+  # the specified location. This must be called from within a custom
+  # Tool. See the Tool class for a complete example.
+  #
+  # Since SketchUp 2016 it is possible to provide vector images for the cursors.
+  # SVG format for Windows and PDF format for OS X.
+  #
+  # @example
+  #   cursor_id = nil
+  #   cursor_path = Sketchup.find_support_file("Pointer.png", "Plugins/")
+  #   if cursor_path
+  #     cursor_id = UI.create_cursor(cursor_path, 0, 0)
+  #   end
+  #
+  #   def onSetCursor
+  #     UI.set_cursor(cursor_id)
+  #   end
+  #
+  # @param filename
+  #   Filename for an image.
+  #
+  # @param hot_x
+  #   An x coordinate that is the "hotpoint" for the cursor
+  #   computed from the left edge of your cursor image.
+  #
+  # @param hot_y
+  #   A y coordinate that is the "hotpoint" for the cursor
+  #   computed from the top edge of the of your cursor image.
+  #   For example, a value of (hot_x, hot_y) = (5,10) would
+  #   identify the hotpoint of the cursor at 5 pixels from
+  #   the left edge of your cursor image and 10 pixels from
+  #   the top edge of your cursor image.
+  #
+  # @return ID - ID associated with the cursor
+  #
+  # @version SketchUp 6.0
+  def self.create_cursor(filename, hot_x, hot_y)
+  end
+
+  # Creates a dialog box for inputting user information. The dialog box contains
+  # input fields with static text prompts, optional default values, optional
+  # drop down selections, and optional title.
+  #
+  # You can also use this method to display drop down lists of options, by
+  # passing an optional param.
+  #
+  # @example
+  #   # With three params, it shows all text boxes:
+  #   prompts = ["What is your Name?", "What is your Age?", "Gender"]
+  #   defaults = ["Enter name", "", "Male"]
+  #   input = UI.inputbox(prompts, defaults, "Tell me about yourself.")
+  #
+  #   # With four params, it shows a drop down box for prompts that have
+  #   # pipe-delimited lists of options. In this case, the Gender prompt
+  #   # is a drop down instead of a text box.
+  #   prompts = ["What is your Name?", "What is your Age?", "Gender"]
+  #   defaults = ["Enter name", "", "Male"]
+  #   list = ["", "", "Male|Female"]
+  #   input = UI.inputbox(prompts, defaults, list, "Tell me about yourself.")
+  #
+  # @param prompts
+  #   An array of prompt names appearing in the input box
+  #   adjacent to input fields.
+  #
+  # @param [optional] defaults
+  #   An array of default values for the input
+  #   fields.
+  #
+  # @param [optional] title
+  #   The title for the input box.
+  #
+  # @param [optional] title_or_list
+  #   If 3 params are passed, then this value is
+  #   a string containing the title of the input box. If
+  #   a total of 4 params are passed, then this is an array
+  #   containing pipe-separated strings of options.
+  #
+  # @return results - An array of returned values if the user did
+  #   not cancel the dialog.  If the user canceled the
+  #   dialog, false is returned.  The returned values in the
+  #   array will be in the same order as the input fields.
+  #
+  # @version SketchUp 6.0
+  def self.inputbox(prompts, defaults, title_or_list, title)
+  end
+
+  # The inspector_names method is used to returns the names of all the
+  # inspectors. Inspectors are another name for the various floating dialog
+  # windows that you can activate from withing SketchUp, such as the Materials
+  # window.
+  #
+  # @example
+  #   inspectors = UI.inspector_names
+  #
+  # @return inspectors - an array of strings containing the names
+  #   of inspectors.
+  #
+  # @version SketchUp 6.0
+  def self.inspector_names
+  end
+
+  # The menu method retrieves a SketchUp's menu object with a given name. This
+  # is the first step toward adding your own custom items to the bottom
+  # of SketchUp's menus.
+  #
+  # Valid menu names are: "File", "Edit", "View", "Camera", "Draw", "Tools",
+  # "Window", "Extensions" and "Help".
+  #
+  # Note that the "Extensions" menu was named "Plugins" prior to SketchUp 2015.
+  # For backward compatibility "Plugins" still works.
+  #
+  # @example
+  #   tool_menu = UI.menu("Tools")
+  #   tool_menu.add_item("Cheese Tool") {
+  #     UI.messagebox("Cheese activated.")
+  #   }
+  #
+  # @param menuname
+  #   Optional. The name of an existing menu. Default menu
+  #   is "Extensions"
+  #
+  # @return menu - a menu object.
+  #
+  # @version SketchUp 6.0
+  def self.menu(menuname = "Extensions")
+  end
+
+  # Creates a dialog box containing static text with a series of buttons for
+  # the user to choose from.
+  #
+  # Valid message box types are:
+  # - +MB_OK+ - Contains an OK button.
+  # - +MB_OKCANCEL+ - Contains OK and Cancel buttons.
+  # - +MB_ABORTRETRYIGNORE+ - Contains Abort, Retry, and Ignore buttons.
+  # - +MB_YESNOCANCEL+ - Contains Yes, No, and Cancel buttons.
+  # - +MB_YESNO+ - Contains Yes and No buttons.
+  # - +MB_RETRYCANCEL+ - Contains Retry and Cancel buttons.
+  # - +MB_MULTILINE+ - Contains and OK button.
+  #
+  # Return values can be any of following:
+  # - +IDOK+
+  # - +IDCANCEL+
+  # - +IDABORT+
+  # - +IDRETRY+
+  # - +IDIGNORE+
+  # - +IDYES+
+  # - +IDNO+
+  #
+  # In an +MB_MULTILINE+ message box, the message is displayed as a multi-line
+  # message with scrollbars (as needed). +MB_MULTILNE+ also allows a third string
+  # argument that will be used as the title for the messagebox.
+  #
+  # @example
+  #   result = UI.messagebox('Do you like cheese?', MB_YESNO)
+  #   if result == IDYES
+  #     UI.messagebox('SketchUp likes cheese too!')
+  #   end
+  #
+  # @param [String] message
+  #   The message that you want to display.
+  #
+  # @param [Integer] type
+  #   The message box type, which will be a constant from
+  #   the list in the method comments.
+  #
+  # @return [Integer] A number corresponding to what the user selected.
+  #
+  # @version SketchUp 6.0
+  def self.messagebox(message, type = MB_OK)
+  end
+
+  # The model_info_pages method is used to returns the names of all the
+  # available model info pages. These include UI windows such as Components,
+  # Credits, and Units.
+  #
+  # @example
+  #   mypages = UI.model_info_pages
+  #
+  # @return mypages - an array of strings containing the names of
+  #   model info pages.
+  #
+  # @version SketchUp 6.0
+  def self.model_info_pages
+  end
+
+  # The openURL method is used to open the default Web browser to a URL.
+  #
+  # @example
+  #   status = UI.openURL("http://www.sketchup.com")
+  #
+  # @param URL
+  #   A string URL.
+  #
+  # @return status - true if successful
+  #
+  # @version SketchUp 6.0
+  def self.openURL(URL)
+  end
+
+  # The openpanel method is used to display the Open dialog box. The path that
+  # is returned can then be used inside code to open a text or image file.
+  # See the standard Ruby class File for examples of reading and writing from
+  # disk.
+  #
+  # Bug Fixed in SketchUp 2014: Wildcards were not working properly from SU7 to
+  # SU2013. Wildcard filters did not populate the file type dropdown. The filter
+  # string would be shown in the file name field with '*' characters converted to
+  # '_' characters. Note, the format of a wildcard filter string has been changed.
+  #  See the description of the filename parameter below for details.
+  #
+  # @example
+  #   chosen_image = UI.openpanel("Open SKP File", "c:/", "model.skp")
+  #   chosen_image = UI.openpanel("Open Image File", "c:/", "Image Files|*.jpg;*.png;||")
+  #   chosen_image = UI.openpanel("Open CAD File", "c:/", "DXF|*.dxf|DWG|*.dwg||")
+  #
+  # @param title
+  #   The title to apply to the open dialog box.
+  #
+  # @param directory
+  #   The default directory for the open panel.
+  #
+  # @param filename
+  #   The default filename for the open panel. On Windows, you
+  #   can alternatively pass a wildcard filter using this
+  #   format: UIname|wildcard||. Additional filter dropdown
+  #   list items can be added by adding additional pairs of
+  #   filter name and filter like this:
+  #   UIname1|wildcard1|UIname2|wildcard2||.
+  #   Also multiple wildcard filters can be combined into a
+  #   single line using a semicolon-separated list in the
+  #   filter field: ui_name|wildcard1;wildcard2||.
+  #
+  # @return string - the full path and name of the file selected, or
+  #   nil if the dialog was canceled.
+  #
+  # @version SketchUp 6.0
+  def self.openpanel(title, directory, filename)
+  end
+
+  # The play_sound method is used to play a sound file. Valid sound files include
+  # .wav and .mp3 files on the Mac and .wav files on the PC.
+  #
+  # @example
+  #   UI.play_sound "Plugins/mediadiscussion.wav"
+  #
+  # @param filename
+  #   the relative path to the filename from the SketchUp
+  #   install directory, or an absolute path to the file. (See
+  #   Sketchup.find_support_file for a way to search for a
+  #   specific file.)
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def self.play_sound(filename)
+  end
+
+  # The preferences_pages method is used to returns the names of all the
+  # preferences pages. These include windows like Extensions.
+  #
+  # @example
+  #   prefs = UI.preferences_pages
+  #
+  # @return prefspages - an array of strings containing the names
+  #   of prefspages.
+  #
+  # @version SketchUp 6.0
+  def self.preferences_pages
+  end
+
+  # Tells SketchUp to refresh all inspectors such as the Component Browser and
+  # the Outliner. This is useful when you need to manually force a refresh after
+  # you've made a change to the document via Ruby. Generally, SketchUp will keep
+  # these in sync for you, but occasionally it does not, such as when
+  # model.start_operation has disabled UI updates.
+  #
+  # @example
+  #   UI.refresh_inspectors
+  #
+  # @return nil
+  #
+  # @version SketchUp 7.0
+  def self.refresh_inspectors
+  end
+
+  # The savepanel method is used to display the Save dialog box. The path that
+  # is returned can then be used inside code to save out a text or image file.
+  # See the standard Ruby class File for examples of reading and writing from
+  # disk.
+  #
+  # Bug Fixed in SketchUp 2014: Wildcards were not working properly from SU7 to
+  # SU2013. Semicolon-separated lists of wildcards did not populate the file type
+  # dropdown. The filter string would be shown in the file name field with '*'
+  # characters converted to '_' characters.
+  #
+  # @example
+  #   path_to_save_to = UI.savepanel("Save Image File", "c:\\", "Shapes.jpg")
+  #
+  # @param title
+  #   The title to apply to the save dialog box.
+  #
+  # @param directory
+  #   The default directory for the save panel.
+  #
+  # @param filename
+  #   The default filename for the save panel. On Windows, you
+  #   can alternatively pass a mask, like "*.txt", to have all
+  #   the .txt files display. If you want multiple file types
+  #   to display, you can supply multiple masks for the
+  #   filename and separate them with a semicolon, like this:
+  #   "*.txt;*.doc".
+  #
+  # @return string - the full path and name of the file
+  #   selected or nil if the dialog was canceled.
+  #
+  # @version SketchUp 6.0
+  def self.savepanel(title, directory, filename)
+  end
+
+  # Returns the scaling factor SketchUp uses on high DPI monitors. Useful for
+  # things like {Sketchup::View#draw2d}.
+  #
+  # @example
+  #   # Scale a set of points representing 2d screen points to account for high
+  #   # DPI monitors.
+  #   points2d = [
+  #     Geom::Point3d.new(0, 0, 0),
+  #     Geom::Point3d.new(8, 0, 0),
+  #     Geom::Point3d.new(8, 4, 0),
+  #     Geom::Point3d.new(0, 4, 0)
+  #   ]
+  #   tr = Geom::Transformation.scaling(UI.scale_factor)
+  #   points2d.each { |point| point.transform!(tr)
+  #
+  # @note SU2017M0 will automatically scale up line width and text size, but will
+  #   not scale up the points provided to {Sketchup::View#draw2d}.
+  #
+  # @return [Float]
+  #
+  # @version SketchUp 2017
+  def self.scale_factor
+  end
+
+  # The select_directory method is used to display the OS dialog for selecting
+  # one or several directories from the file system.
+  #
+  # Options:
+  # - :title             string  The title for the dialog.
+  # - :directory         string  Force the starting directory for the dialog. If
+  #                              not specified the last chosen directory will be
+  #                              used
+  # - :select_multiple   boolean Set to true to allow multiple items to be
+  #                              selected.
+  #
+  # @example
+  #   # Default title and folder:
+  #   chosen_folder = UI.select_directory
+  #
+  #   # Custom dialog title:
+  #   chosen_folder = UI.select_directory(title: "Select Image Directory")
+  #
+  #   # Force a start folder:
+  #   chosen_folder = UI.select_directory(directory: "C:/images")
+  #
+  #   # Allow multiple items to the selected:
+  #   chosen_folder = UI.select_directory(select_multiple: true)
+  #
+  #   # Custom dialog title and force a start folder:
+  #   chosen_folder = UI.select_directory(
+  #     title: "Select Image Directory",
+  #     directory: "C:/images"
+  #   )
+  #
+  # @param options
+  #   hash (optional)   The dialog can be customized by
+  #   providing a hash or named arguments of
+  #   options.
+  #
+  # @return string or array - A string with the full path of the
+  #   directory selected when
+  #   :select_multiple option is set to
+  #   false otherwise an array of strings
+  #   or nil if the user cancelled.
+  #
+  # @version SketchUp 2015
+  def self.select_directory(options)
+  end
+
+  # The set_cursor method is used to change the cursor to a new cursor with a
+  # given cursor id. See UI.create_cursor and the Tool class for details
+  # on creating your own tools with arbitrary cursors.
+  #
+  # If you call this while a standard SketchUp tool is active, you will not
+  # see your custom cursor, as these tools are constantly setting their
+  # own cursors to indicate SketchUp's state.
+  #
+  # @example
+  #   def onSetCursor
+  #     UI.set_cursor(cursor_id)
+  #   end
+  #
+  # @param cursor_id
+  #   The id of the cursor you want to display.
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def self.set_cursor(cursor_id)
+  end
+
+  # The set_toolbar_visible method is used to set whether a given toolbar is
+  # visible.  Note that the toolbars and their names are different on the
+  # Mac vs. PC, so be careful and be sure to test when using this method in a
+  # cross-platform script.
+  #
+  # @example
+  #   status = UI.set_toolbar_visible("Camera", true)
+  #
+  # @param name
+  #   The name of a Ruby toolbar.
+  #
+  # @param visible
+  #   True to make the toolbar visible, false to hide it.
+  #
+  # @return result - true if successful, false if not.
+  #
+  # @version SketchUp 6.0
+  def self.set_toolbar_visible(name, visible)
+  end
+
+  # The +show_extension_manager+ method is used to display the Extension Manager
+  # dialog.
+  #
+  # @example
+  #   UI.show_extension_manager
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2017
+  def self.show_extension_manager
+  end
+
+  # The show_inspector method is used to display the inspector with the given
+  # name. You can get the list of valid inspectors with UI.inspector_names.
+  #
+  # @example
+  #   status = UI.show_inspector "Components"
+  #
+  # @param name
+  #   The name of inspector that you want to display.
+  #
+  # @return status - true if successful, false if unsuccessful
+  #
+  # @version SketchUp 6.0
+  def self.show_inspector(name)
+  end
+
+  # The show_model_info method is used to display the model info dialog for a
+  # specific page. You can get the list of valid dialogs with
+  # UI.model_info_pages.
+  #
+  # @example
+  #   status = UI.show_model_info('Credits')
+  #
+  # @param page_name
+  #   The name of the model info dialog you want to display.
+  #
+  # @return status - true
+  #
+  # @version SketchUp 6.0
+  def self.show_model_info(page_name)
+  end
+
+  # The show_preferences method is used to display a SketchUp preferences dialog.
+  # You can get the list of valid dialogs with UI.preferences_pages.
+  #
+  # Note that under OSX this method doesn't currently work.
+  #
+  # @example
+  #   status = UI.show_preferences('GraphicsCard')
+  #
+  # @param page_name
+  #   The name of the preferences dialog you want to display.
+  #
+  # @return status - true
+  #
+  # @version SketchUp 6.0
+  def self.show_preferences(page_name)
+  end
+
+  # The start_timer method is used to start a timer. This is an effective method
+  # to create a repeating snippet of code for arbitrary animation.
+  #
+  # See this blog post for an detailed example of custom animation using timers:
+  # http://sketchupapi.blogspot.com/2008/10/animate-yo-cheese.html
+  #
+  # Note that there is a bug that if you open a modal window in a non-repeating
+  # timer the timer will repeat until the window is closed.
+  #
+  # @example
+  #   # Beep once after 10 seconds.
+  #   id = UI.start_timer(10, false) { UI.beep }
+  #
+  # @param [optional] repeat
+  #   true if you want the timer to repeat, false
+  #   (or omit) if you do not want it to repeat.
+  #
+  # @param seconds
+  #   The time in seconds before your code should be called.
+  #
+  # @return timer - a timer ID
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [procedure] The procedure you want to execute after seconds has
+  #   expired.
+  def self.start_timer(seconds, repeat = false)
+  end
+
+  # The stop_timer method is used to stop a timer based on its id.
+  #
+  # @example
+  #   # Stop timer before it triggers.
+  #   id = UI.start_timer(10) { UI.beep }
+  #   UI.stop_timer(id)
+  #
+  # @param id
+  #   The timer id for the timer that you want to stop.
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def self.stop_timer(id)
+  end
+
+  # The toolbar method is used to get a Ruby toolbar by name. If the toolbar
+  # doesn't exist a new one will be created.
+  #
+  # @example
+  #   toolbar = UI.toolbar('Test')
+  #
+  # @param name
+  #   The name of the Ruby toolbar.
+  #
+  # @return toolbar - a Toolbar object
+  #
+  # @version SketchUp 6.0
+  def self.toolbar(name)
+  end
+
+  # The toolbar_names method is used to return the name of all the available
+  # native toolbars (this differs between PC and Mac). These toolbar names
+  # do not include Ruby toolbars.
+  #
+  # @example
+  #   names = UI.toolbar_names
+  #
+  # @return names - Array of strings representing toolbar names.
+  #
+  # @version SketchUp 6.0
+  def self.toolbar_names
+  end
+
+  # The toolbar_visible? method is used to determine whether a given toolbar is
+  # visible. Note that the toolbars and their names are different on the
+  # Mac vs. PC, so be careful and be sure to test when using this method in a
+  # cross-platform script.
+  #
+  # @example
+  #   status = UI.toolbar_visible?("Camera")
+  #
+  # @param name
+  #   The name of a native toolbar.
+  #
+  # @return status - true if successful, false if unsuccessful
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def self.toolbar_visible?(name)
+  end
+
+end