Where to find the definition of `reviewStateShortcuts` in the source code?

rodrigomorales · July 12, 2024, 4:02pm

I have noticed some people use reviewStateShortcuts to map keys in the add-ons they write. For example:

glutanimate/anki-addons-misc Github repository: anki-addons-misc/src/reviewer_more_answer_buttons/more_answer_buttons/reviewer_more_answer_buttons_for_21.py at 7b981836e0a6637a1853f3e8d73d022ab95fed31 · glutanimate/anki-addons-misc · GitHub
A comment in Reddit: https://www.reddit.com/r/Anki/comments/a9xwth/comment/ecp873r
A post in this forum: https://forums.ankiweb.net/t/how-to-fallback-to-default-keystroke-handlers-for-shortcuts/23088

I wanted to see the definition of reviewStateShortcut in the Anki source code. I used grep to search reviewStateShortcuts, but I found 0 matches. See code block below.

$ rm -rf /tmp/anki \
  && git clone --branch main --depth 1 'https://github.com/ankitects/anki' /tmp/anki \
  && grep -R 'reviewStateShortcuts' /tmp/anki | wc -l

$ cd /tmp/anki \
  && git log -S 'reviewStateShortcuts' | wc -l

My question is: Where can I find the definition of reviewStateShortcuts?

While I appreciate that some of you might explain what reviewStateShortcuts does, I’m more interested in finding its definition in the source code so that I can inspect it by myself and thus find out more information on how to properly use it.

abdo · July 14, 2024, 7:01am

It’s a legacy hook called here:

github.com

ankitects/anki/blob/9d8782c31ca87b1de1a3d7e60d5bc4c2590479a1/qt/aqt/main.py#L1162


      
              qshortcuts = []
              for key, fn in self._normalize_shortcuts(shortcuts):
                  scut = QShortcut(key, self, activated=fn)  # type: ignore
                  scut.setAutoRepeat(False)
                  qshortcuts.append(scut)
              return qshortcuts
          
          def setStateShortcuts(self, shortcuts: list[tuple[str, Callable]]) -> None:
              gui_hooks.state_shortcuts_will_change(self.state, shortcuts)
              # legacy hook
              runHook(f"{self.state}StateShortcuts", shortcuts)
              self.stateShortcuts = self.applyShortcuts(shortcuts)
          
          def clearStateShortcuts(self) -> None:
              for qs in self.stateShortcuts:
                  sip.delete(qs)  # type: ignore
              self.stateShortcuts = []
          
          def onStudyKey(self) -> None:
              if self.state == "overview":
                  self.col.startTimebox()

Use the state_shortcuts_will_change hook in new code:

github.com

ankitects/anki/blob/9d8782c31ca87b1de1a3d7e60d5bc4c2590479a1/qt/tools/genhooks_gui.py#L597


      
          Hook(
              name="state_did_change",
              args=[
                  "new_state: aqt.main.MainWindowState",
                  "old_state: aqt.main.MainWindowState",
              ],
              legacy_hook="afterStateChange",
          ),
          # different sig to original
          Hook(
              name="state_shortcuts_will_change",
              args=[
                  "state: aqt.main.MainWindowState",
                  "shortcuts: list[tuple[str, Callable]]",
              ],
          ),
          # UI state/refreshing
          ###################
          Hook(
              name="state_did_undo",
              args=["changes: OpChangesAfterUndo"],

system · August 13, 2024, 7:01am

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Keyboard Shortcut Usage? Help	2	402	May 1, 2023
Anki 2.1.63 Release Candidate Beta Testing	6	1048	May 15, 2023
Change new shortcuts in 2.1.63? Beta Testing	15	539	June 19, 2023
I'm trying to improve the translation, but I can't find it in one place, please help me ~ Help	22	995	December 3, 2023
Reading Anki Source Code Development	3	3838	May 1, 2023

Where to find the definition of `reviewStateShortcuts` in the source code?

Related topics