Clipboard.dll

Clipboard.dll is a plugin for Rainmeter that will display the current contents of the Windows Clipboard.

Contents

• Features
• Options
• Commands
• Changes
• Download
• Build Instructions
• Examples

Features

Here are some of the features of the Clipboard plugin:

• Uses the Parent/Child structure.
• Once loaded, the plugin "remembers" any text that is copied to the Windows Clipboard. If the skin gets unloaded or refreshed, all indices will be deleted.
• Once new text is copied to the clipboard, the plugin pushes everything back 1 spot. So Index=0 will always¹ represent the current contents of the clipboard.
• The string is converted to a number (if applicable).

#####Warning: When displaying the contents of the Windows Clipboard, it is highly recommended to include a Width and Height in your String meter. Otherwise, your string meter will expand to the edge of your skin. Or worse yet, if you are using DynamicWindowSize and no Width and Height in your String meter, the contents of the clipboard could take up your entire screen.

######¹ If TextOnly=1 then Index=0 will not equal the current contents of the Windows Clipboard.

Options

###For Parent measures only:

• TextOnly - When "1", only logs text items in the Windows Clipboard. When "0" and non-text items are copied to the Windows Clipboard, then the ErrorString is returned. (TextOnly=0 is default)
• ErrorString - This is what is returned when non-text is copied to the Windows Clipboard. For example, if you copy a file or an image, then ErrorString will be returned. (An empty string is default.)
• MaxIndex - This number represents the number of indices that will be available. This is to avoid high memory usage by the plugin. It is recommended to have this number equal the number of indices you plan on referencing. For instance, you plan on referencing Index=5, set MaxIndex=5. A MaxIndex=-1 means that the measure will remember ALL indices, which can take up a lot of memory. If you use this option, it is recommended to use the "Clear" command periodically. (MaxIndex=15 is default)

#####Example:

[ParentMeasure]
Measure=Plugin
Plugin=Clipboard
TextOnly=0
ErrorString=<Invalid data>

###For Child measure only:

• ParentName - The name of the Parent Measure. Do not include brackets. ie. ParentName=ParentMeasure is valid. ParentName=[ParentMeasure] is invalid.

#####Example:

[ChildMeasure]
Measure=Plugin
Plugin=Clipboard
ParentName=ParentMeasure

###For ALL Clipboard measures:

• Index - Represents the current content of the Windows Clipboard. Can be used on both Parent and Child measures. (Index=0 is default)

Commands

Commands only work on Parent Measures.

• Clear - Clears the contents of the Windows Clipboard and clears all indices of the Parent measure. Also, Index=0 of other Parent measures will be deleted only if Index=0 equals the same on both Parents.

  Usage: !CommandMeasure ParentMeasure Clear

• ClearIndex n - Clears index "n" and moves other indices to a lower index. If n=0, the Windows Clipboard is cleared, and only Index=0 (not all indices) - It also will delete Index=0 from other Parent measures if the data is the same.

  Usage: !CommandMeasure ParentMeasure "ClearIndex 2"

• CopyIndex n - Copies string at index n to the Windows Clipboard.

  Usage: !CommandMeasure ParentMeasure "CopyIndex 2"

Changes

Here is a list of the major changes to the plugin.

#####Version:

• 1.0.3 - Added MaxIndex support for Parent measures to avoid high memory usage.
• 1.0.2 - Changed TextOnly to work with "0/1" instead of "Off/On"
• 1.0.1 - Removed support for command "Copy". Use !SetClip instead.

Download

####To download the current source code:

• Using git: git clone git@github.com:brianferguson/Clipboard.dll.git
• Download as a .zip

####To download current plugin (.dll):

• 32-bit version
• 64-bit version

Build Instructions

This plugin was written in c++ using the Rainmeter Plugin SDK

To build this source code, you will need Visual Studio 2010. If you are using any paid version of Visual Studio (Professional, Premium, Ultimate, etc.) you can open "PluginClipboard.sln" and build from there. If you are using Visual C++ 2010 Express, then please install the following in order:

1. Visual Studio 2010 Express Edition
2. Visual Studio 2010 SP1
3. Windows 7.1 SDK
4. KB2519277 compiler update

Then you can open "PluginClipboard.sln" and build from there.

Examples

####Example 1: This example will save the last 3 items copied to the Windows Clipboard. Since "MeasureParent" doesn't have a TextOnly option, it is turned off, meaning any non-text that is copied to the Windows Clipboard will return <Invalid Data>.

[MeasureParent]
Measure=Plugin
Plugin=Clipboard
MaxIndex=2
ErrorString=<Invalid Data>
;Index=0

[MeasureChild1]
Measure=Plugin
Plugin=Clipboard
ParentName=MeasureParent
Index=1

[MeasureChild2]
Measure=Plugin
Plugin=Clipboard
ParentName=MeasureParent
Index=2

####Example 2: This example will save the last 3 text-only items copied to the Windows Clipboard. ErrorString has no meaning when using the option TextOnly.

[MeasureParent]
Measure=Plugin
Plugin=Clipboard
MaxIndex=2
TextOnly=1
Index=0

[MeasureChild1]
Measure=Plugin
Plugin=Clipboard
ParentName=MeasureParent
Index=1

[MeasureChild2]
Measure=Plugin
Plugin=Clipboard
ParentName=MeasureParent
Index=2