DockGuard.spoon/docs.json at main · ohyoungpark/DockGuard.spoon · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
[
  {
    "Constant" : [

    ],
    "submodules" : [

    ],
    "Function" : [

    ],
    "Variable" : [

    ],
    "stripped_doc" : [

    ],
    "desc" : "Prevent the macOS Dock from moving from the main monitor (the one with the menu bar) to another monitor.",
    "Deprecated" : [

    ],
    "type" : "Module",
    "Constructor" : [

    ],
    "doc" : "Prevent the macOS Dock from moving from the main monitor (the one with the menu bar) to another monitor.\nWhen the mouse cursor approaches the bottom edge of a screen, DockGuard nudges the cursor upward to prevent the Dock from moving.\nThis is almost unnoticeable in normal use.\n\nUsage example in your init.lua:\nhs.loadSpoon(\"DockGuard\")\nspoon.DockGuard:start()\n\nThe default config is as follows:\n    edgeTriggerMargin = 1,        -- Number of pixels from the bottom edge to trigger the nudge\n    mouseNudgeDistance = 1,       -- Number of pixels to nudge the cursor upward\n    watcherRestartDelay = 0.1,    -- Delay (in seconds) before restarting the watcher after nudging\n\nYou can override these defaults before calling :start(), for example:\nhs.loadSpoon(\"DockGuard\")\nspoon.DockGuard.edgeTriggerMargin = 5 -- Trigger within 5px of the bottom edge\nspoon.DockGuard.mouseNudgeDistance = 2 -- Nudge cursor up by 2px\nspoon.DockGuard.watcherRestartDelay = 0.2 -- Restart watcher after 0.2s\nspoon.DockGuard:start()\nNote: If 'Automatically hide and show the Dock' is enabled, this plugin may not work as expected.",
    "Field" : [

    ],
    "Command" : [

    ],
    "items" : [
      {
        "doc" : "Starts monitoring mouse movement. When the mouse cursor approaches the bottom edge of the main screen, it nudges the cursor upward to prevent the Dock from moving to another monitor.\n\nParameters:\n * None",
        "stripped_doc" : [
          "Starts monitoring mouse movement. When the mouse cursor approaches the bottom edge of the main screen, it nudges the cursor upward to prevent the Dock from moving to another monitor.",
          ""
        ],
        "parameters" : [
          " * None"
        ],
        "name" : "start",
        "notes" : [

        ],
        "signature" : "DockGuard:start()",
        "type" : "Method",
        "returns" : [

        ],
        "def" : "DockGuard:start()",
        "desc" : "Starts monitoring mouse movement. When the mouse cursor approaches the bottom edge of the main screen, it nudges the cursor upward to prevent the Dock from moving to another monitor."
      },
      {
        "doc" : "Stops monitoring mouse movement and allows the Dock to move to another monitor.\n\nParameters:\n * None",
        "stripped_doc" : [
          "Stops monitoring mouse movement and allows the Dock to move to another monitor.",
          ""
        ],
        "parameters" : [
          " * None"
        ],
        "name" : "stop",
        "notes" : [

        ],
        "signature" : "DockGuard:stop()",
        "type" : "Method",
        "returns" : [

        ],
        "def" : "DockGuard:stop()",
        "desc" : "Stops monitoring mouse movement and allows the Dock to move to another monitor."
      }
    ],
    "Method" : [
      {
        "doc" : "Starts monitoring mouse movement. When the mouse cursor approaches the bottom edge of the main screen, it nudges the cursor upward to prevent the Dock from moving to another monitor.\n\nParameters:\n * None",
        "stripped_doc" : [
          "Starts monitoring mouse movement. When the mouse cursor approaches the bottom edge of the main screen, it nudges the cursor upward to prevent the Dock from moving to another monitor.",
          ""
        ],
        "parameters" : [
          " * None"
        ],
        "name" : "start",
        "notes" : [

        ],
        "signature" : "DockGuard:start()",
        "type" : "Method",
        "returns" : [

        ],
        "def" : "DockGuard:start()",
        "desc" : "Starts monitoring mouse movement. When the mouse cursor approaches the bottom edge of the main screen, it nudges the cursor upward to prevent the Dock from moving to another monitor."
      },
      {
        "doc" : "Stops monitoring mouse movement and allows the Dock to move to another monitor.\n\nParameters:\n * None",
        "stripped_doc" : [
          "Stops monitoring mouse movement and allows the Dock to move to another monitor.",
          ""
        ],
        "parameters" : [
          " * None"
        ],
        "name" : "stop",
        "notes" : [

        ],
        "signature" : "DockGuard:stop()",
        "type" : "Method",
        "returns" : [

        ],
        "def" : "DockGuard:stop()",
        "desc" : "Stops monitoring mouse movement and allows the Dock to move to another monitor."
      }
    ],
    "name" : "DockGuard"
  }
]