alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1570 from davep/title-docs

Browse Source 
Add docstrings to app title an sub-titles
This commit is contained in:
Dave Pearson
2023-01-16 15:45:13 +00:00
committed by GitHub
parent 23bfb08693 cb7adb78bf
commit 632e82818d
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
src/textual/app.py
View File

@@ -240,8 +240,20 @@ class App(Generic[ReturnType], DOMNode):
SCREENS: dict[str, Screen | Callable[[], Screen]] = {} SCREENS: dict[str, Screen | Callable[[], Screen]] = {}
_BASE_PATH: str | None = None _BASE_PATH: str | None = None
CSS_PATH: CSSPathType = None CSS_PATH: CSSPathType = None
TITLE: str | None = None TITLE: str | None = None
"""str | None: The default title for the application.
If set to a string, this sets the default title for the application. See
also the `title` attribute.
"""
SUB_TITLE: str | None = None SUB_TITLE: str | None = None
"""str | None: The default sub-title for the application.
If set to a string, this sets the default sub-title for the application. See
also the `sub_title` attribute.
"""
BINDINGS = [ BINDINGS = [
Binding("ctrl+c", "quit", "Quit", show=False, priority=True), Binding("ctrl+c", "quit", "Quit", show=False, priority=True),
@@ -303,10 +315,24 @@ class App(Generic[ReturnType], DOMNode):
self._animator = Animator(self) self._animator = Animator(self)
self._animate = self._animator.bind(self) self._animate = self._animator.bind(self)
self.mouse_position = Offset(0, 0) self.mouse_position = Offset(0, 0)
self.title = ( self.title = (
self.TITLE if self.TITLE is not None else f"{self.__class__.__name__}" self.TITLE if self.TITLE is not None else f"{self.__class__.__name__}"
) )
"""The title for the application.
The initial value in a running application will be that set in `TITLE`
(if one is set). Assign new values to this instance attribute to change
the title.
"""
self.sub_title = self.SUB_TITLE if self.SUB_TITLE is not None else "" self.sub_title = self.SUB_TITLE if self.SUB_TITLE is not None else ""
"""The sub-title for the application.
The initial value in a running application will be that set in `SUB_TITLE`
(if one is set). Assign new values to this instance attribute to change
the sub-title.
"""
self._logger = Logger(self._log) self._logger = Logger(self._log)