API reference - Class LayoutView::SelectionMode

Notation used in Ruby API documentation

Module: lay

Description: Specifies how selected objects interact with already selected ones.

This class is equivalent to the class LayoutView::SelectionMode

This enum was introduced in version 0.27.

Public constructors

new LayoutView::SelectionMode ptrnew(int i)Creates an enum from an integer value
new LayoutView::SelectionMode ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const LayoutView::SelectionMode other)Compares two enums for inequality
[const]bool<(const LayoutView::SelectionMode other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool==(const LayoutView::SelectionMode other)Compares two enums
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum

Public static methods and constants

[static,const]LayoutView::SelectionModeAddAdds to any existing selection
[static,const]LayoutView::SelectionModeInvertAdds to any existing selection, if it's not there yet or removes it from the selection if it's already selected
[static,const]LayoutView::SelectionModeReplaceReplaces the existing selection
[static,const]LayoutView::SelectionModeResetRemoves from any existing selection

Detailed description

!=

Signature: [const] bool != (const LayoutView::SelectionMode other)

Description: Compares two enums for inequality

<

Signature: [const] bool < (const LayoutView::SelectionMode other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

==

Signature: [const] bool == (const LayoutView::SelectionMode other)

Description: Compares two enums

Add

Signature: [static,const] LayoutView::SelectionMode Add

Description: Adds to any existing selection

Invert

Signature: [static,const] LayoutView::SelectionMode Invert

Description: Adds to any existing selection, if it's not there yet or removes it from the selection if it's already selected

Replace

Signature: [static,const] LayoutView::SelectionMode Replace

Description: Replaces the existing selection

Reset

Signature: [static,const] LayoutView::SelectionMode Reset

Description: Removes from any existing selection

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'

new

(1) Signature: [static] new LayoutView::SelectionMode ptr new (int i)

Description: Creates an enum from an integer value

Python specific notes:
This method is the default initializer of the object

(2) Signature: [static] new LayoutView::SelectionMode ptr new (string s)

Description: Creates an enum from a string value

Python specific notes:
This method is the default initializer of the object

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'