retype Logo
latest

Usage

  • Getting started
  • Running from sources
  • Build instructions
    • Build command options
    • Build kinds
      • onedir
      • onefile
      • hacky
  • Build docs locally
  • Dependencies
  • Available features

User interface

  • Main Window
  • Shelf View
  • Book View
    • Toolbar actions
    • Modeline
    • Stats Dock
  • Console
    • The prompt
    • Console commands
    • Command history
  • Customisation Dialog
    • Paths
      • User dir
      • Library search paths
    • Console
      • Prompt
      • Hide System Console window on UI load (Windows-only)
    • Book View
      • Font size
    • Replacements
    • Window Geometry
  • About Dialog

Code reference

  • retype
    • retype.app
      • retype.app.run
        • run()
      • run()
    • retype.constants
      • retype.constants.getBuilddate
        • getBuilddate()
      • getBuilddate()
    • retype.resource_handler
      • retype.resource_handler.getIcon
        • getIcon()
      • retype.resource_handler.getIconsPath
        • getIconsPath()
      • retype.resource_handler.getIncludePath
        • getIncludePath()
      • retype.resource_handler.getLibraryPath
        • getLibraryPath()
      • retype.resource_handler.getStylePath
        • getStylePath()
      • getIcon()
      • getIconsPath()
      • getIncludePath()
      • getLibraryPath()
      • getStylePath()
    • retype.controllers
      • LibraryController
        • LibraryController.addFriendlyName()
        • LibraryController.indexLibrary()
        • LibraryController.instantiateBooks()
        • LibraryController.load()
        • LibraryController.loadSaveFile()
        • LibraryController.migrateV1Save()
        • LibraryController.save()
        • LibraryController.setBook()
        • LibraryController.user_dir
      • MainController
        • MainController.aboutDialogRequested
        • MainController.customisationDialogRequested
        • MainController.getGeometry()
        • MainController.isVisible()
        • MainController.loadBook()
        • MainController.loadBookRequested
        • MainController.openUrl()
        • MainController.prevView()
        • MainController.prevViewRequested
        • MainController.quit()
        • MainController.saveConfig()
        • MainController.saveConfigRequested
        • MainController.setView()
        • MainController.setViewByEnum()
        • MainController.show()
        • MainController.showAboutDialog()
        • MainController.showCustomisationDialog()
        • MainController.switchView()
        • MainController.switchViewRequested
        • MainController.view()
        • MainController.views
      • MenuController
      • SafeConfig
        • SafeConfig.get()
        • SafeConfig.isPathDefaultUserDir()
        • SafeConfig.load()
        • SafeConfig.save()
      • retype.controllers.library
        • retype.controllers.library.BookWrapper
        • retype.controllers.library.LibraryController
        • retype.controllers.library.LibraryItem
        • BookWrapper
        • LibraryController
        • LibraryItem
      • retype.controllers.main_controller
        • retype.controllers.main_controller.MainController
        • retype.controllers.main_controller.View
        • MainController
        • View
      • retype.controllers.menu_controller
        • retype.controllers.menu_controller.MenuController
        • MenuController
      • retype.controllers.safe_config
        • retype.controllers.safe_config.ConfigGroup
        • retype.controllers.safe_config.SafeConfig
        • ConfigGroup
        • SafeConfig
    • retype.ui
      • AboutDialog
        • AboutDialog.acknowledgementsPage()
        • AboutDialog.consoleCommandsPage()
        • AboutDialog.setActivePage()
        • AboutDialog.youPage()
      • BookView
        • BookView.advanceLine()
        • BookView.anchorClicked()
        • BookView.fillHighlight()
        • BookView.font_family
        • BookView.font_size
        • BookView.gotoCursorPosition()
        • BookView.markComplete()
        • BookView.maybeSave()
        • BookView.nextChapter()
        • BookView.nextChapterAction()
        • BookView.onLastChapter()
        • BookView.previousChapter()
        • BookView.previousChapterAction()
        • BookView.setBook()
        • BookView.setChapter()
        • BookView.setCursor()
        • BookView.setHighlightCursor()
        • BookView.setMistakeCursor()
        • BookView.setSource()
        • BookView.switchToShelves()
        • BookView.updateCursorPosition()
        • BookView.updateHighlightCursor()
        • BookView.updateModeline()
        • BookView.updateProgress()
        • BookView.updateToolbarActions()
      • Cover
        • Cover.enterEvent()
        • Cover.leaveEvent()
        • Cover.paintEvent()
        • Cover.sizeHint()
      • CustomisationDialog
        • CustomisationDialog.accept()
        • CustomisationDialog.maybeSaveCertainThings()
        • CustomisationDialog.restoreDefaults()
        • CustomisationDialog.revert()
        • CustomisationDialog.setSelectors()
        • CustomisationDialog.sizeHint()
        • CustomisationDialog.update()
      • LineEdit
        • LineEdit.cursorPositionChanged
        • LineEdit.font()
        • LineEdit.keyPressEvent()
        • LineEdit.minimumSizeHint()
        • LineEdit.returnPressed
        • LineEdit.selectionChanged
        • LineEdit.setAccessibleName()
        • LineEdit.setFont()
        • LineEdit.setPlainText()
        • LineEdit.setSizePolicy()
        • LineEdit.setStyleSheet()
        • LineEdit.setText()
        • LineEdit.sizeHint()
        • LineEdit.text()
        • LineEdit.textChanged
        • LineEdit.textEdited
      • MainWin
        • MainWin.closeEvent()
        • MainWin.closing
        • MainWin.currentView()
        • MainWin.denoteSplitter()
        • MainWin.maybeRestoreSplitterState()
        • MainWin.opened
        • MainWin.showEvent()
      • ShelfView
        • ShelfView.eventFilter()
        • ShelfView.keyPressEvent()
        • ShelfView.repopulate()
      • retype.ui.about_dialog
        • retype.ui.about_dialog.format_page_details
        • retype.ui.about_dialog.AboutDialog
        • retype.ui.about_dialog.AboutPage
        • retype.ui.about_dialog.ReadOnlyTextWidget
        • AboutDialog
        • AboutPage
        • ReadOnlyTextWidget
        • format_page_details()
      • retype.ui.book_view
        • retype.ui.book_view.BookDisplay
        • retype.ui.book_view.BookView
        • BookDisplay
        • BookView
      • retype.ui.cover
        • retype.ui.cover.CompleteIndicator
        • retype.ui.cover.Cover
        • retype.ui.cover.HoverCover
        • retype.ui.cover.PregeneratedCover
        • CompleteIndicator
        • Cover
        • HoverCover
        • PregeneratedCover
      • retype.ui.customisation_dialog
        • retype.ui.customisation_dialog.descl
        • retype.ui.customisation_dialog.hline
        • retype.ui.customisation_dialog.npxspinbox
        • retype.ui.customisation_dialog.pxspinbox
        • retype.ui.customisation_dialog.BookViewSettingsWidget
        • retype.ui.customisation_dialog.CheckBox
        • retype.ui.customisation_dialog.ConsoleFontSelector
        • retype.ui.customisation_dialog.CustomisationDialog
        • retype.ui.customisation_dialog.Delegate
        • retype.ui.customisation_dialog.LibraryPathsModel
        • retype.ui.customisation_dialog.LibraryPathsWidget
        • retype.ui.customisation_dialog.PathDelegate
        • retype.ui.customisation_dialog.PathSelector
        • retype.ui.customisation_dialog.PromptEdit
        • retype.ui.customisation_dialog.RDictDelegate
        • retype.ui.customisation_dialog.RDictEntryEditor
        • retype.ui.customisation_dialog.RDictModel
        • retype.ui.customisation_dialog.RDictWidget
        • retype.ui.customisation_dialog.WindowGeometrySelector
        • BookViewSettingsWidget
        • CheckBox
        • ConsoleFontSelector
        • CustomisationDialog
        • Delegate
        • LibraryPathsModel
        • LibraryPathsWidget
        • PathDelegate
        • PathSelector
        • PromptEdit
        • RDictDelegate
        • RDictEntryEditor
        • RDictModel
        • RDictWidget
        • WindowGeometrySelector
        • descl()
        • hline()
        • npxspinbox()
        • pxspinbox()
      • retype.ui.line_edit
        • retype.ui.line_edit.LineEdit
        • LineEdit
      • retype.ui.main_win
        • retype.ui.main_win.MainWin
        • MainWin
      • retype.ui.modeline
        • retype.ui.modeline.Modeline
        • retype.ui.modeline.Separator
        • retype.ui.modeline.Spacer
        • retype.ui.modeline.WidgetsGroup
        • Modeline
        • Separator
        • Spacer
        • WidgetsGroup
      • retype.ui.painting
        • retype.ui.painting.arcPixmap
        • retype.ui.painting.ellipsePixmap
        • retype.ui.painting.linePixmap
        • retype.ui.painting.rectPixmap
        • retype.ui.painting.textPixmap
        • retype.ui.painting.Font
        • Font
        • arcPixmap()
        • ellipsePixmap()
        • linePixmap()
        • rectPixmap()
        • textPixmap()
      • retype.ui.shelf_view
        • retype.ui.shelf_view.IDNDisplay
        • retype.ui.shelf_view.ProgressBar
        • retype.ui.shelf_view.ShelfItem
        • retype.ui.shelf_view.ShelfView
        • IDNDisplay
        • ProgressBar
        • ShelfItem
        • ShelfView
    • retype.console
      • CommandService
        • CommandService.advanceLine()
        • CommandService.commandHistoryDown()
        • CommandService.commandHistoryUp()
        • CommandService.customise()
        • CommandService.gotoCursorPosition()
        • CommandService.help_()
        • CommandService.load()
        • CommandService.onBookView()
        • CommandService.setChapter()
        • CommandService.switch()
      • Console
        • Console.clear()
        • Console.font_family
        • Console.initServices()
        • Console.keyPressEvent()
        • Console.prompt
        • Console.resizeEvent()
        • Console.submitted
        • Console.transferFocus()
      • HighlightingService
        • HighlightingService.advanceLine()
        • HighlightingService.updateHighlighting()
      • retype.console.command_service
        • retype.console.command_service.CommandService
        • CommandService
      • retype.console.console
        • retype.console.console.Console
        • Console
      • retype.console.highlighting_service
        • retype.console.highlighting_service.compareStrings
        • retype.console.highlighting_service.HighlightingService
        • HighlightingService
        • compareStrings()
    • retype.stats
      • StatsDock
        • StatsDock.connectConsole()
        • StatsDock.onUpdate()
        • StatsDock.paintEvent()
        • StatsDock.sizeHint()
      • retype.stats.stats_dock
        • retype.stats.stats_dock.StatsDock
        • StatsDock
    • retype.layouts
      • RowLayout
        • RowLayout.addItem()
        • RowLayout.count()
        • RowLayout.doLayout()
        • RowLayout.expandingDirections()
        • RowLayout.itemAt()
        • RowLayout.minimumSize()
        • RowLayout.setGeometry()
        • RowLayout.sizeHint()
        • RowLayout.takeAt()
      • ShelvesWidget
        • ShelvesWidget.addWidget()
        • ShelvesWidget.clearWidgets()
        • ShelvesWidget.setContentsMargins()
      • retype.layouts.rowlayout
        • retype.layouts.rowlayout.RowLayout
        • RowLayout
      • retype.layouts.shelveslayout
        • retype.layouts.shelveslayout.ShelvesLayout
        • retype.layouts.shelveslayout.ShelvesWidget
        • ShelvesLayout
        • ShelvesWidget
    • retype.extras
      • AnyStr
        • AnyStr.isspace()
        • AnyStr.join()
        • AnyStr.lstrip()
        • AnyStr.rstrip()
        • AnyStr.strip()
      • ManifoldStr
        • ManifoldStr.by_parts()
        • ManifoldStr.from_anystr_and_anystr()
        • ManifoldStr.from_anystr_and_ms()
        • ManifoldStr.from_anystr_and_str()
        • ManifoldStr.from_ms_and_anystr()
        • ManifoldStr.from_ms_and_ms()
        • ManifoldStr.from_ms_and_str()
        • ManifoldStr.from_str_and_anystr()
        • ManifoldStr.from_str_and_ms()
        • ManifoldStr.isspace()
        • ManifoldStr.join()
        • ManifoldStr.lstrip()
        • ManifoldStr.rstrip()
        • ManifoldStr.strip()
      • retype.extras.hashing
        • retype.extras.hashing.generate_file_md5
        • generate_file_md5()
      • retype.extras.str_subclasses
        • retype.extras.str_subclasses.AnyStr
        • retype.extras.str_subclasses.ManifoldStr
        • AnyStr
        • ManifoldStr
      • retype.extras.utils
        • retype.extras.utils.isspace
        • retype.extras.utils.isspaceorempty
        • retype.extras.utils.spacerstrip
        • retype.extras.utils.update
        • isspace()
        • isspaceorempty()
        • spacerstrip()
        • update()
retype
  • retype
  • Edit on GitHub

retype

Modules

retype.app

retype.constants

retype.resource_handler

retype.controllers

retype.ui

retype.console

retype.stats

retype.layouts

retype.extras

Previous Next

© Copyright none (Public Domain). Revision d69f3fad.

Built with Sphinx using a theme provided by Read the Docs.