Module nari.types.event.visibility

Classes for visibility state management

"""Classes for visibility state management"""
from enum import Enum, auto

from nari.types import Timestamp
from nari.types.event import Event
from nari.types.actor import Actor

# pylint: disable=invalid-name
class VisibilityCategory(Enum):
    """Enums for concepts that have visibility"""
    Nameplate = auto()


class VisibilityState(Enum):
    """Enum for the state of the visiblity change"""
    Invisibile = 0
    Visible = 1


class VisibilityChange(Event): # pylint: disable=too-few-public-methods
    """Represents a visibility change"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 actor: Actor,
                 visibility_category: VisibilityCategory,
                 state: VisibilityState,
                ):
        super().__init__(timestamp)
        self.actor = actor
        self.visibility_category = visibility_category
        self.state = state

    def __repr__(self):
        return f'<Visibility {self.visibility_category.name}>'

Classes

class VisibilityCategory (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enums for concepts that have visibility

Expand source code

class VisibilityCategory(Enum):
    """Enums for concepts that have visibility"""
    Nameplate = auto()

Ancestors

• enum.Enum

Class variables

var Nameplate

class VisibilityChange (*, timestamp: int, actor: Actor, visibility_category: VisibilityCategory, state: VisibilityState)

Represents a visibility change

Expand source code

class VisibilityChange(Event): # pylint: disable=too-few-public-methods
    """Represents a visibility change"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 actor: Actor,
                 visibility_category: VisibilityCategory,
                 state: VisibilityState,
                ):
        super().__init__(timestamp)
        self.actor = actor
        self.visibility_category = visibility_category
        self.state = state

    def __repr__(self):
        return f'<Visibility {self.visibility_category.name}>'

Ancestors

• Event

class VisibilityState (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enum for the state of the visiblity change

Expand source code

class VisibilityState(Enum):
    """Enum for the state of the visiblity change"""
    Invisibile = 0
    Visible = 1

Ancestors

• enum.Enum

Class variables

var Invisibile

var Visible