Class: Layout::Layer
- Inherits:
-
Object
- Object
- Layout::Layer
- Defined in:
- lib/sketchup-api-stubs/stubs/Layout/Layer.rb
Overview
This is the interface to a LayOut Layer Definition. A layer definition specifies the document-wide information about a layer. To access the entities on a layer for a given page, use LayerInstance.
Constant Summary collapse
- SHARELAYERACTION_CLEAR =
Constants
nil
- SHARELAYERACTION_KEEPONEPAGE =
Stub value.
nil
- SHARELAYERACTION_MERGEALLPAGES =
Stub value.
nil
- UNSHARELAYERACTION_CLEAR =
Stub value.
nil
- UNSHARELAYERACTION_COPYTOALLPAGES =
Stub value.
nil
- UNSHARELAYERACTION_COPYTOONEPAGE =
Stub value.
nil
Instance Method Summary collapse
- #==(other) ⇒ Boolean
- #document ⇒ Layout::Document
-
#layer_instance(page) ⇒ Object
The #layer_instance method returns a LayerInstance from the Layer.
- #locked=(locked) ⇒ Object
- #locked? ⇒ Boolean
- #name ⇒ String
- #name=(name) ⇒ Object
-
#set_nonshared(page, unshare_action) ⇒ Object
The #set_nonshared method sets the Layer to non-shared.
-
#set_shared(page, share_action) ⇒ Object
The #set_shared method sets the Layer to shared.
- #shared? ⇒ Boolean
Instance Method Details
#==(other) ⇒ Boolean
The #== method checks to see if the two Layout::Layers are equal. This checks whether the Ruby Objects are pointing to the same internal object.
44 45 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 44 def ==(other) end |
#document ⇒ Layout::Document
The #document method returns the Document that the Layout::Layer belongs to.
59 60 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 59 def document end |
#layer_instance ⇒ Layout::LayerInstance #layer_instance(page) ⇒ Layout::LayerInstance
The #layer_instance method returns a Layout::LayerInstance from the Layout::Layer. If the Layout::Layer is shared, a Page does not have to be provided.
85 86 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 85 def layer_instance(page) end |
#locked=(locked) ⇒ Object
The #locked= method sets whether the Layout::Layer is locked.
103 104 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 103 def locked=(locked) end |
#locked? ⇒ Boolean
The #locked? method returns whether the Layout::Layer is locked.
116 117 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 116 def locked? end |
#name ⇒ String
The #name method returns the name of the Layout::Layer.
129 130 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 129 def name end |
#name=(name) ⇒ Object
The #name= sets the name of the Layout::Layer.
144 145 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 144 def name=(name) end |
#set_nonshared(page, unshare_action) ⇒ Object
The #set_nonshared method sets the Layout::Layer to non-shared.
The unshare action can be one of the following values:
Layout::Layer::UNSHARELAYERACTION_CLEAR
Layout::Layer::UNSHARELAYERACTION_COPYTOONEPAGE
Layout::Layer::UNSHARELAYERACTION_COPYTOALLPAGES
173 174 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 173 def set_nonshared(page, unshare_action) end |
#set_shared(page, share_action) ⇒ Object
The #set_shared method sets the Layout::Layer to shared.
The share action can be one of the following values:
Layout::Layer::SHARELAYERACTION_CLEAR
Layout::Layer::SHARELAYERACTION_KEEPONEPAGE
Layout::Layer::SHARELAYERACTION_MERGEALLPAGES
202 203 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 202 def set_shared(page, share_action) end |
#shared? ⇒ Boolean
The #shared? method returns whether the Layout::Layer is shared.
215 216 |
# File 'lib/sketchup-api-stubs/stubs/Layout/Layer.rb', line 215 def shared? end |