Skip to content

Documentation: data attribute semantics #32

@ulinja

Description

@ulinja

In the documentation, for many of the data attributes, the actual semantic meaning of what that attribute describes is just Unknown. Here's an example of unknown attributes for the Window component:

self.swallows: str | None = None if data.swallows == "0x0" else data.swallows
#: Unknown.
self.focus_history_id: int = data.focus_history_id
#: Unknown.
self.inhibiting_idle: bool = data.inhibiting_idle
#: Unknown.
self.xdg_tag: str = data.xdg_tag
#: Unknown.
self.xdg_description: str = data.xdg_description

Monitor components also have quite a few unknown attributes:

#: Unknown.
self.serial: str = data.serial
#: Width of the monitor (in pixels).
self.width: int = data.width
#: Height of the monitor (in pixels).
self.height: int = data.height
#: Refresh rate of the monitor (in Hz).
self.refresh_rate: float = data.refresh_rate
#: Unknown.
self.position_x: int = data.position_x
#: Unknown.
self.position_y: int = data.position_y
#: Numeric ID of the workspace currently active on the monitor.
self.active_workspace_id: int = data.active_workspace_id
#: Assigned name of the workspace currently active on the monitor.
self.active_workspace_name: str = data.active_workspace_name
#: Unknown.
self.reserved: List[int] = data.reserved
#: Unknown.
self.scale: float = data.scale
#: Unknown.
self.transform: int = data.transform
#: Whether or not the currently focused window is on this monitor.
self.is_focused: bool = data.is_focused
#: Whether or not the monitor uses DPMS.
self.uses_dpms: bool = data.uses_dpms
#: Unknown.
self.vrr: bool = data.vrr
#: Whether or not the monitor is currently disabled.
self.is_disabled: bool = data.is_disabled
#: Unknown.
self.mirror_of: str | None = None if data.mirror_of == "none" else data.mirror

These are marked as unknown because I'm simply not sure what they're for 🤔 If you're more knowledgeable about Hyprland internals or have any ideas, please let me know and help me improve the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions