sketchup-api-stubs 0.1.0

data/SketchUp/UI/Notification.rb

@@ -0,0 +1,229 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# UI::Notification objects allows you to show native notifications in the
+# desktop, they are positioned in the top right of your screen, they can be
+# customized to have a message, icon and accept and/or dismiss buttons with
+# callback blocks.
+#
+# @version SketchUp 2017
+class UI::Notification
+
+  # Instance Methods
+
+  # Gets the icon name, this is the path that will be used to get the icon from
+  # the file system path.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
+  #   puts "Icon Name: #{notification.icon_name}"
+  #   notification.show
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def icon_name
+  end
+
+  # Sets the icon path, this icon will be loaded from the path give, the path
+  # has to be a local filesystem path.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world")
+  #   notification.icon_name = "/path/to/icon"
+  #   notification.show
+  #
+  # @param [String] icon_name
+  #   String providing the icon filesystem path.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def icon_name=(icon_name)
+  end
+
+  # Gets the icon Tooltip, this is the string that appear when the mouse is over
+  # the icon.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
+  #   puts "Tooltip: " notification.icon_tooltip
+  #   notification.show
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def icon_tooltip
+  end
+
+  # Sets the icon Tooltip, this string will appear when the mouse is over the
+  # icon.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world")
+  #   notification.icon_tooltip = "icon Tooltip"
+  #   notification.show
+  #
+  # @param [String] icon_tooltip
+  #   String providing the new icon Tooltip.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def icon_tooltip=(icon_tooltip)
+  end
+
+  # The new method is used to create a new {UI::Notification}.
+  #
+  # In order to insert line breaks into the message you need to use +\\r\\n+.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
+  #   notification.show
+  #
+  # @param [String] icon_tooltip
+  #   Optionally set an image tooltip.
+  #
+  # @param [String] icon_name
+  #   Optionally set a path to an image.
+  #
+  # @param [String] message
+  #   Optionally assign the message.
+  #
+  # @param [SketchupExtension] sketchup_extension
+  #   Required sketchup_extension
+  #   to identify the sender.
+  #
+  # @return [UI::Notification]
+  #
+  # @version SketchUp 2017
+  def initialize(sketchup_extension, message, icon_name, icon_tooltip)
+  end
+
+  # Gets the message as string.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension)
+  #   puts "This is the current message: ${notification.message}"
+  #   notification.show
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def message
+  end
+
+  # Sets a new message, notifications are meant for quick & brief messages,
+  # remember that they are dismissed automatically.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension)
+  #   notification.message = "Hello world"
+  #   notification.show
+  #
+  # @param [String] message
+  #   String providing the new message.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def message=(message)
+  end
+
+  # Shows a button in the notification with the given title and callback block,
+  # both arguments are required.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world")
+  #   notification.on_accept("Accept")  do |notification, title|
+  #      puts "The user pressed [#{title}] with message #{notification.message}"
+  #   end
+  #   notification.show
+  #
+  # @param [String] title
+  #   Sets the title of the button.
+  #
+  # @param [Block] block
+  #   Sets the action callback, this will be called when
+  #   the user clicks on the dismiss button.
+  #
+  # @raise [RuntimeError] When calling on_accept when the notification has
+  #   already been shown.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def on_accept(title, block)
+  end
+
+  # Returns the accept's button title.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world")
+  #   notification.on_accept("Accept")  do |notification, title|
+  #      puts "The user pressed #{notification.on_accept_title}"
+  #   end
+  #   notification.show
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def on_accept_title
+  end
+
+  # Shows a button in the notification with the given title and callback block,
+  # both arguments are required.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world")
+  #   notification.on_dismiss("Close")  do |notification, title|
+  #      puts "The user pressed [#{title}] with message #{notification.message}"
+  #   end
+  #   notification.show
+  #
+  # @param [String] title
+  #   Sets the title of the button.
+  #
+  # @param [Block] block
+  #   Sets the action callback, this will be called when
+  #   the user clicks on the dismiss button.
+  #
+  # @raise [RuntimeError] When calling on_dismiss when the notification has
+  #   already been shown.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def on_dismiss(title, block)
+  end
+
+  # Returns the dismiss's button title.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world")
+  #   notification.on_dismiss("Close")  do |notification, title|
+  #      puts "The user pressed #{notification.on_dismiss_title}"
+  #   end
+  #   notification.show
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def on_dismiss_title
+  end
+
+  # Shows the notification in the top right of the screen, the notifications will
+  # be ordered from top to bottom if multiple notifications are shown, it will
+  # automatically be dismissed if no action is taken.
+  #
+  # @example
+  #   notification = UI::Notification.new(sketchup_extension, "Hello world")
+  #   notification.show
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def show
+  end
+
+end

data/SketchUp/UI/Toolbar.rb

@@ -0,0 +1,243 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Toolbar class contains methods to create and manipulate SketchUp
+# toolbars in Ruby. Toolbars are collections of buttons that you can use
+# to activate custom Tools or ruby scripts.
+#
+# Also see the Command object for details on creating "commands" which
+# can be called from your toolbars.
+#
+# @example
+#   toolbar = UI::Toolbar.new "Test"
+#   # This toolbar icon simply displays Hello World on the screen
+#   cmd = UI::Command.new("Test") {
+#     UI.messagebox "Hello World"
+#   }
+#   cmd.small_icon = "ToolPencilSmall.png"
+#   cmd.large_icon = "ToolPencilLarge.png"
+#   cmd.tooltip = "Test Toolbars"
+#   cmd.status_bar_text = "Testing the toolbars class"
+#   cmd.menu_text = "Test"
+#   toolbar = toolbar.add_item cmd
+#   toolbar.show
+#
+# @version SketchUp 6.0
+class UI::Toolbar
+
+  # Includes
+
+  include Enumerable
+
+  # Class Methods
+
+  # The new method creates a new Toolbar object.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #
+  # @param toolbarname
+  #   The name for the new toolbar.
+  #
+  # @return toolbar - the newly created toolbar object
+  #
+  # @version SketchUp 6.0
+  def self.new(toolbarname)
+  end
+
+  # Instance Methods
+
+  # The add_item method is used to add an item to the toolbar.
+  #
+  # @example
+  #   toolbar = toolbar.add_item command
+  #
+  # @param command
+  #   A Command object representing the command to add to the
+  #   toolbar.
+  #
+  # @return toolbar - the toolbar where the command was just added
+  #
+  # @version SketchUp 6.0
+  def add_item(command)
+  end
+
+  # The add_separator method is used to add a line separator to the toolbar.
+  #
+  # @example
+  #   toolbar = toolbar.add_separator
+  #
+  # @return toolbar - the toolbar where the line separator was just
+  #   added
+  #
+  # @version SketchUp 6.0
+  def add_separator
+  end
+
+  # The {#count} method is inherited from the +Enumerable+ mix-in module.
+  #
+  # @example
+  #   number = toolbar.count
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def count
+  end
+
+  # The each method is used to iterate through all of the commands
+  # attached to a toolbar.
+  #
+  # @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") }
+  #   toolbar.add_item cmd
+  #   toolbar = toolbar.add_separator
+  #   cmd = UI::Command.new("Test 2") { UI.messagebox("Hello World 2") }
+  #   toolbar.add_item cmd
+  #   toolbar.show
+  #   toolbar.each { | item |
+  #     puts item
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 8.0 M1
+  #
+  # @yield [key, value] Variables that will hold each key and value as they are
+  #   found.
+  def each
+  end
+
+  # The get_last_state method is used to determine if the toolbar was hidden or
+  # visible in the previous session of SketchUp.
+  #
+  # Valid states are 1 for visible, 0 for hidden, -1 for before never shown.
+  #
+  # @example
+  #   state = toolbar.get_last_state
+  #
+  # @return state - the last state of the toolbar (see comments)
+  #
+  # @version SketchUp 6.0
+  def get_last_state
+  end
+
+  # The hide method is used to hide the toolbar on the user interface.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This toolbar icon simply displays Hello World on the screen
+  #   cmd = UI::Command.new("Test") {
+  #     UI.messagebox "Hello World"
+  #   }
+  #   cmd.small_icon = "ToolPencilSmall.png"
+  #   cmd.large_icon = "ToolPencilLarge.png"
+  #   cmd.tooltip = "Test Toolbars"
+  #   cmd.status_bar_text = "Testing the toolbars class"
+  #   cmd.menu_text = "Test"
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #   UI.messagebox "Toolbar Showing"
+  #   toolbar.hide
+  #   UI.messagebox "Toolbar Hidden"
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def hide
+  end
+
+  # The {#length} method returns the number of items in the toolbar.
+  #
+  # The {#size} method is an alias of {#length}.
+  #
+  # @example
+  #   number = toolbar.length
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def length
+  end
+
+  # The name method returns the name of the toolbar.
+  #
+  # @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") }
+  #   toolbar.add_item cmd
+  #   toolbar = toolbar.add_separator
+  #   cmd = UI::Command.new("Test 2") { UI.messagebox("Hello World 2") }
+  #   puts toolbar.name
+  #   toolbar.show
+  #
+  # @return string - the name of the toolbar.
+  #
+  # @version SketchUp 8.0 M1
+  def name
+  end
+
+  # The restore method is used to reposition the toolbar to its previous
+  # location and show if not hidden.
+  #
+  # @example
+  #   toolbar.restore
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def restore
+  end
+
+  # The show method is used to display the toolbar in the user interface.
+  #
+  # @example
+  #   toolbar = UI::Toolbar.new "Test"
+  #   # This toolbar icon simply displays Hello World on the screen
+  #   cmd = UI::Command.new("Test") {
+  #     UI.messagebox "Hello World"
+  #   }
+  #   cmd.small_icon = "ToolPencilSmall.png"
+  #   cmd.large_icon = "ToolPencilLarge.png"
+  #   cmd.tooltip = "Test Toolbars"
+  #   cmd.status_bar_text = "Testing the toolbars class"
+  #   cmd.menu_text = "Test"
+  #   toolbar = toolbar.add_item cmd
+  #   toolbar.show
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def show
+  end
+
+  # The {#length} method returns the number of items in the toolbar.
+  #
+  # The {#size} method is an alias of {#length}.
+  #
+  # @example
+  #   number = toolbar.length
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def size
+  end
+
+  # The visible? method is used to find out if a toolbar is currently visible.
+  #
+  # @example
+  #   visible = toolbar.visible?
+  #
+  # @return true if visible
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def visible?
+  end
+
+end