Notation used in Ruby API documentation
Module: lay
Description: Specifies the format of a macro
This class is equivalent to the class Macro::Format
This enum has been introduced in version 0.27.5.
| new Macro::Format ptr | new | (int i) | Creates an enum from an integer value |
| new Macro::Format ptr | new | (string s) | Creates an enum from a string value |
| [const] | bool | != | (const Macro::Format other) | Compares two enums for inequality |
| [const] | bool | < | (const Macro::Format other) | Returns true if the first enum is less (in the enum symbol order) than the second |
| [const] | bool | == | (const Macro::Format other) | Compares two enums |
| [const] | string | inspect | Converts an enum to a visual string | |
| [const] | int | to_i | Gets the integer value from the enum | |
| [const] | string | to_s | Gets the symbolic string from an enum |
| [static,const] | Macro::Format | MacroFormat | The macro has macro (XML) format | |
| [static,const] | Macro::Format | PlainTextFormat | The macro has plain text format | |
| [static,const] | Macro::Format | PlainTextWithHashAnnotationsFormat | The macro has plain text format with special pseudo-comment annotations |
!= | Signature: [const] bool != (const Macro::Format other) Description: Compares two enums for inequality |
< | Signature: [const] bool < (const Macro::Format other) Description: Returns true if the first enum is less (in the enum symbol order) than the second |
== | Signature: [const] bool == (const Macro::Format other) Description: Compares two enums |
MacroFormat | Signature: [static,const] Macro::Format MacroFormat Description: The macro has macro (XML) format |
PlainTextFormat | Signature: [static,const] Macro::Format PlainTextFormat Description: The macro has plain text format |
PlainTextWithHashAnnotationsFormat | Signature: [static,const] Macro::Format PlainTextWithHashAnnotationsFormat Description: The macro has plain text format with special pseudo-comment annotations |
inspect | Signature: [const] string inspect Description: Converts an enum to a visual string Python specific notes: |
new | (1) Signature: [static] new Macro::Format ptr new (int i) Description: Creates an enum from an integer value Python specific notes: |
(2) Signature: [static] new Macro::Format ptr new (string s) Description: Creates an enum from a string value Python specific notes: | |
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: |