UmbraEdit/umbraedit/enum.py

"""
UmbraEdit - Enums
===================

This file is a part of UmbraEdit.

Copyright (C) 2018 Veronica Berglyd Olsen and UmbraEdit contributors.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
"""  # noqa

from enum import Enum, StrEnum


class nwItemType(Enum):
    """Enum: Project Item Types."""

    NO_TYPE = 0
    ROOT = 1
    FOLDER = 2
    FILE = 3


class nwItemClass(Enum):
    """Enum: Project Item Classes."""

    NO_CLASS = 0
    NOVEL = 1
    PLOT = 2
    CHARACTER = 3
    WORLD = 4
    TIMELINE = 5
    OBJECT = 6
    ENTITY = 7
    CUSTOM = 8
    ARCHIVE = 9
    TEMPLATE = 10
    TRASH = 11


class nwItemLayout(Enum):
    """A project item's layout."""

    NO_LAYOUT = 0
    DOCUMENT = 1
    NOTE = 2


class nwComment(Enum):
    """Types of text comments."""

    PLAIN = 0
    IGNORE = 1
    SYNOPSIS = 2
    SHORT = 3
    NOTE = 4
    FOOTNOTE = 5
    COMMENT = 6
    STORY = 7


class nwChange(Enum):
    """Change request modes."""

    CREATE = 0
    UPDATE = 1
    DELETE = 2


class nwDocMode(Enum):
    """Document open modes."""

    VIEW = 0
    EDIT = 1


class nwDocAction(Enum):
    """Document actions."""

    NO_ACTION = 0
    UNDO = 1
    REDO = 2
    CUT = 3
    COPY = 4
    PASTE = 5
    MD_ITALIC = 6
    MD_BOLD = 7
    MD_STRIKE = 8
    MD_MARK = 9
    MD_LINK = 10
    S_QUOTE = 11
    D_QUOTE = 12
    SEL_ALL = 13
    SEL_PARA = 14
    BLOCK_H1 = 15
    BLOCK_H2 = 16
    BLOCK_H3 = 17
    BLOCK_H4 = 18
    BLOCK_COM = 19
    BLOCK_IGN = 20
    BLOCK_TXT = 21
    BLOCK_LST_U = 22
    BLOCK_LST_O = 23
    BLOCK_TTL = 24
    BLOCK_UNN = 25
    BLOCK_HSC = 26
    REPL_SNG = 27
    REPL_DBL = 28
    RM_BREAKS = 29
    ALIGN_L = 30
    ALIGN_C = 31
    ALIGN_R = 32
    INDENT_L = 33
    INDENT_R = 34
    SC_ITALIC = 35
    SC_BOLD = 36
    SC_STRIKE = 37
    SC_ULINE = 38
    SC_MARK = 39
    SC_SUP = 40
    SC_SUB = 41
    MOVE_TEXT = 42
    ZOOM_IN = 43
    ZOOM_OUT = 44
    ZOOM_RESET = 45


class nwDocInsert(Enum):
    """Document insert actions."""

    NO_INSERT = 0
    QUOTE_LS = 1
    QUOTE_RS = 2
    QUOTE_LD = 3
    QUOTE_RD = 4
    SYNOPSIS = 5
    SHORT = 6
    NEW_PAGE = 7
    VSPACE_S = 8
    VSPACE_M = 9
    LIPSUM = 10
    FOOTNOTE = 11
    LINE_BRK = 12


class nwView(Enum):
    """Main GUI view modes."""

    EDITOR = 0
    PROJECT = 1
    NOVEL = 2
    STORY = 3
    SEARCH = 4


class nwFocus(Enum):
    """Main GUI panel focus."""

    TREE = 1
    DOCUMENT = 2
    STORY = 3


class nwTheme(Enum):
    """GUI theme colour modes."""

    AUTO = 0
    LIGHT = 1
    DARK = 2


class nwNovelExtra(Enum):
    """Enum: Novel View Extra Columns."""

    HIDDEN = 0
    POV = 1
    FOCUS = 2
    PLOT = 3


class nwBuildFmt(Enum):
    """Enum: Manuscript Document Formats."""

    ODT = 0
    FODT = 1
    DOCX = 2
    PDF = 3
    HTML = 4
    EPUB = 5
    STD_MD = 6
    EXT_MD = 7
    NWD = 8
    J_HTML = 9
    J_NWD = 10


class nwStatusShape(Enum):
    """Enum: Status/Importance Icon Shapes."""

    SQUARE = 0
    TRIANGLE = 1
    NABLA = 2
    DIAMOND = 3
    PENTAGON = 4
    HEXAGON = 5
    STAR = 6
    PACMAN = 7
    CIRCLE_Q = 8
    CIRCLE_H = 9
    CIRCLE_T = 10
    CIRCLE = 11
    BARS_1 = 12
    BARS_2 = 13
    BARS_3 = 14
    BARS_4 = 15
    BLOCK_1 = 16
    BLOCK_2 = 17
    BLOCK_3 = 18
    BLOCK_4 = 19


class nwVimMode(Enum):
    """Enum: Vim mode different modes."""

    NORMAL = 0
    INSERT = 1
    VISUAL = 2
    V_LINE = 3


class nwStandardButton(Enum):
    """Enum: Standard Dialog Buttons."""

    OK = 0
    CANCEL = 1
    YES = 2
    NO = 3
    OPEN = 4
    CLOSE = 5
    SAVE = 6
    BROWSE = 7
    LIST = 8
    NEW = 9
    CREATE = 10
    RESET = 11
    INSERT = 12
    APPLY = 13
    BUILD = 14
    PRINT = 15
    PREVIEW = 16


class nwToolButton(Enum):
    """Enum: Standard Tool Buttons."""

    ADD = 0
    REMOVE = 1
    MOVE_UP = 2
    MOVE_DOWN = 3
    IMPORT = 4
    EXPORT = 5
    BROWSE = 6
    EDIT = 7
    REVERT = 8
    FONT = 9


class nwState(Enum):
    """Enum: Object state values."""

    NORMAL = 0
    INACTIVE = 1
    ERROR = 2


class nwStdLabel(Enum):
    """Enum: Standard Labels."""

    NOTE = 0
    STORY = 1
    STORY_STRUCTURE = 2
    SYNOPSIS = 3


class nwStdUnit(Enum):
    """Enum: Standard Units."""

    CHARS = 0
    WORDS = 1
    LINES = 2
    PIXELS = 3
    POINTS = 4
    EM = 5
    SECONDS = 6
    MINUTES = 7


class nwProjectKind(StrEnum):
    """Enum: Project Kind."""

    PROJECT = "project"
    BACKUP = "backup"
    TEMPLATE = "template"