Keyboard Maestro Wiki

User Tools

Site Tools

Trace: • COSH • Trigger_File • MONTH • MJD • DAY • RAND • TIME • MIN • TIME2JD • JSON
function:SCREEN

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
function:SCREEN [2020/06/11 08:25] – peternlewisfunction:SCREEN [2023/09/20 07:47] (current) – peternlewis
Line 1: Line 1:
-The //SCREEN()// and //SCREENVISIBLE// functions return the position or size of a screen.  //SCREENVISIBLE()// refers to the visible section of the screen, excluding the menu bar and the dock.+====== SCREEN Functions ======
  
-    SCREEN( index [number OR name], coordinate ) +The SCREEN() and SCREENVISIBLE() functions return the position or size of a screen.  SCREENVISIBLE() refers to the visible section of the screen, excluding the menu bar and the dock.
-    SCREEN( index [number OR name], coordinate, percentage )+
  
-The SCREEN *index* can be referenced by either a _number_ OR a _name_.  The _Index number_ can be 0 for the main screen, and then 1 through n are the screens in orientation order from left to right (and top down for screens at the same position).  _Index Names_ are shown below.+The SCREENINDEX() function (v10.0+) returns the actual index of the specified screen, counting from left to right.
  
-The _Main_ screen is set by your macOS System Preferences. +``` 
-The other screens (monitors) are referenced positionally from the left most screen, which may, or _may not_, be the _Main_ screen.+SCREEN( index [number OR name], coordinate ) 
 +SCREEN( index [number OR name], coordinate, percentage ) 
 +``` 
 + 
 +The SCREEN //index// can be referenced by either a //number// or a //name//.  The //Index Number// can be 0 for the main screen, and then 1 through SCREENCOUNT() are the screens in orientation order from left to right (and top down for screens at the same position).  //Index Names// are shown below. 
 + 
 +The //Main// screen is set by your macOS System Preferences. 
 + 
 +The other screens (monitors) are referenced positionally from the left most screen, which may or may not, be the //Main// screen.
  
 ^ Index Name ^ Description ^ ^ Index Name ^ Description ^
Line 23: Line 30:
 | Variable Name | the index value based on the value of the variable (v9.0+). | | Variable Name | the index value based on the value of the variable (v9.0+). |
  
-:!: Note: Since the _Main_ screen can be in any position, be advised of the following: +:!: Note: Since the //Main// screen can be in any position: 
-  * SCREEN(0) is always the _Main_ screen. +  * SCREEN(0) is always the //Main// screen. 
-  * SCREEN(1) may or may not be the _Main_ screen. +  * SCREEN(1) may or may not be the //Main// screen. 
-  * SCREEN(2+) may or may not be the _Main_ screen. +  * SCREEN(2+) may or may not be the //Main// screen.
  
-The SCREEN *coordinate* can be:+The SCREEN //coordinate// can be:
  
 * Left * Left
Line 41: Line 47:
 * Index (v9.0+) * Index (v9.0+)
  
-The optional SCREEN *percentage* parameter specifies a percentage of the width or height to offset by. Offsets are always to the right and down, but negative offsets are allowed.+The optional SCREEN //percentage// parameter specifies a percentage of the width or height to offset by. Offsets are always to the right and down, but negative offsets are allowed.
  
-For example SCREEN(Internal,Left,10%) would be the coordinate of left edge of the internal screen plus 10% of the width of the internal screen. SCREEN(Front,Right,-10%) would be the coordinate of the right edge of the external screen minus 10% of the width of the external screen.+For example SCREEN(Internal,Left,10%) would be the coordinate of left edge of the internal screen plus 10% of the width of the internal screen. SCREEN(Front,Right,-10%) would be the coordinate of the right edge of the front screen minus 10% of the width of the front screen.
  
 SCREEN sizes and positions are in //nominal resolution pixels// (so a retina screen will typically have half as many nominal resolution pixels as raw pixels). SCREEN sizes and positions are in //nominal resolution pixels// (so a retina screen will typically have half as many nominal resolution pixels as raw pixels).
Line 53: Line 59:
 ==== Actions ==== ==== Actions ====
  
-* [[action:Manipulate a Window|Manipulate a Window]] +* [[action:Manipulate a Window|Manipulate a Window]] action 
-* [[action:Move or Click Mouse|Move or Click Mouse]]+* [[action:Move or Click Mouse|Move or Click Mouse]] action
 * [[:Actions|See all Actions]] * [[:Actions|See all Actions]]
  
 ==== Functions ==== ==== Functions ====
  
-* [[function:MENUBARHEIGHT|MENUBARHEIGHT()]] +* [[MENUBARHEIGHT]] 
-* [[function:MOUSEBUTTON|MOUSEBUTTON()]] +* [[MOUSEBUTTON]] 
-* [[function:MOUSEX|MOUSEX()]] +* [[MOUSEX]] 
-* [[function:MOUSEY|MOUSEY()]] +* [[MOUSEY]] 
-* [[function:SCREENCOUNT|SCREENCOUNT()]] +* [[SCREENCOUNT]] 
-* [[function:WINDOW|WINDOW()]] +* [[WINDOW]] 
-* [[function:WINDOWCOUNT|WINDOWCOUNT()]]+* [[WINDOWCOUNT]]
 * [[:Functions|See all Functions]] * [[:Functions|See all Functions]]
  
 === Tokens === === Tokens ===
  
-* [[token:Screen|%Screen%]] +* [[token:Screen|%Screen%]] token 
-* [[token:ScreenVisible|%ScreenVisible%]]+* [[token:ScreenVisible|%ScreenVisible%]] token
 * [[:Tokens|See all Tokens]] * [[:Tokens|See all Tokens]]
  
function/SCREEN.1591863910.txt.gz · Last modified: by peternlewis
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki