Mouse Actions

Mouse actions are action options used on any visible part of the skin. The action is triggered by specific mouse events.

Usage

  • On any meter. The target area detected by the mouse will be any non-tranparent areas of the meter, or any part of the meter which has a non-transparent meter or skin background behind it.
  • In the [Rainmeter] section of the skin if Background is defined.

Note: Actions defined for a meter will override actions defined in the [Rainmeter] section.

Mouse Click Options

Note: Mouse Click Options may be overridden by holding down CTRL while clicking.

LeftMouseDownAction

Action to execute when the left mouse button is pressed.

Note: This disables dragging the skin. See LeftMouseUpAction.

RightMouseDownAction

Action to execute when the right mouse button is pressed.

Note: This disables the skin context menu.

MiddleMouseDownAction

Action to execute when the middle mouse button is pressed.

LeftMouseUpAction

Action to execute when the left mouse button is released.

Note: This will generally be the desired option for a left mouse click. LeftMouseDownAction should be avoided unless there is a specific need to trap the downward press, as it will disable the ability to drag the skin.

RightMouseUpAction

Action to execute when the right mouse button is released.

Note: This disables the skin context menu.

MiddleMouseUpAction

Action to execute when the middle mouse button is released.

LeftMouseDoubleClickAction

Action to execute when the left mouse button is double clicked.

Note: If LeftMouseDownAction or LeftMouseUpAction is also set, both will be executed.

RightMouseDoubleClickAction

Action to execute when the right mouse button is double clicked.

Note: This disables the skin context menu.

MiddleMouseDoubleClickAction

Action to execute when the middle mouse button is double clicked.

X1MouseDownAction, X2MouseDownAction

Action to execute when a supported extra mouse button is pressed.

Note: Some manufacturers and/or software have the ability to change what each extra button can do, therefore these actions may not work for everyone. It is not recommended to distribute skins that rely on these actions.

X1MouseUpAction, X2MouseUpAction

Action to execute when a supported extra mouse button is released.

X1MouseDoubleClickAction, X2MouseDoubleClickAction

Action to execute when a supported extra mouse button is double clicked.

Mouse Hover Options

MouseOverAction

Action to execute when the mouse cursor is moved over the meter or skin.

MouseLeaveAction

Action to execute when the mouse cursor leaves the meter or skin.

Mouse Wheel Scroll Options

Actions to be taken when the mouse scroll wheel is rotated while the cursor is over a skin or meter containing the option.

MouseScrollDownAction

Action to execute when the mouse wheel is rotated down.

MouseScrollUpAction

Action to execute when the mouse wheel is rotated up.

MouseScrollLeftAction

Action to execute when the mouse wheel is tilted or rotated to the left. Not all mice have this capability.

MouseScrollRightAction

Action to execute when the mouse wheel is tilted or rotated to the right. Not all mice have this capability.

Mouse Cursor Options

MouseActionCursor Default: 1

When set to 1 (default) on a meter with a mouse action, a pointer cursor will be shown when hovering the mouse over the meter.

The default for the entire skin can be set to 0 by putting MouseActionCursor=0 in the [Rainmeter] section of the skin. This can then be overridden on a meter-by-meter basis with MouseActionCursor=1.

Note: If you have a meter with a mouse action, and there is a meter on top of it, you will need to set MouseActionCursor=0 on the foreground meter (even if it does not have a mouse action).

MouseActionCursorName

If a custom cursor file (i.e. .cur or .ani) is found in @Resources\Cursors in the root config folder of a skin, it will be automatically loaded and available as an alternative for the standard "hand" pointer for meters or skins with a mouse action.

The option can be used with MouseActionCursorName=MyCustomCursor.cur in any meter or the [Rainmeter] section. No path is used in the option. In addition, several built-in Windows cursors may be used without needing any file name or extension. Hand, Text, Help, Busy, Cross, Pen