mirror of
https://github.com/Stone-Red-Code/DesktopMagic.git
synced 2026-09-04 08:56:15 +02:00
Added documentation to the DesktopMagicPluginAPI
This commit is contained in:
@@ -10,8 +10,16 @@
|
||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||
</PropertyGroup>
|
||||
|
||||
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
|
||||
<DocumentationFile>C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\DesktopMagicPluginAPI.xml</DocumentationFile>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="System.Drawing.Common" Version="5.0.2" />
|
||||
<PackageReference Include="Vsxmd" Version="1.4.5">
|
||||
<PrivateAssets>all</PrivateAssets>
|
||||
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
||||
</PackageReference>
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
@@ -0,0 +1,493 @@
|
||||
<a name='assembly'></a>
|
||||
# DesktopMagicPluginAPI
|
||||
|
||||
## Contents
|
||||
|
||||
- [Button](#T-DesktopMagicPluginAPI-Inputs-Button 'DesktopMagicPluginAPI.Inputs.Button')
|
||||
- [#ctor(value)](#M-DesktopMagicPluginAPI-Inputs-Button-#ctor-System-String- 'DesktopMagicPluginAPI.Inputs.Button.#ctor(System.String)')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-Button-Value 'DesktopMagicPluginAPI.Inputs.Button.Value')
|
||||
- [Click()](#M-DesktopMagicPluginAPI-Inputs-Button-Click 'DesktopMagicPluginAPI.Inputs.Button.Click')
|
||||
- [CheckBox](#T-DesktopMagicPluginAPI-Inputs-CheckBox 'DesktopMagicPluginAPI.Inputs.CheckBox')
|
||||
- [#ctor(value)](#M-DesktopMagicPluginAPI-Inputs-CheckBox-#ctor-System-Boolean- 'DesktopMagicPluginAPI.Inputs.CheckBox.#ctor(System.Boolean)')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-CheckBox-Value 'DesktopMagicPluginAPI.Inputs.CheckBox.Value')
|
||||
- [Element](#T-DesktopMagicPluginAPI-Inputs-Element 'DesktopMagicPluginAPI.Inputs.Element')
|
||||
- [ValueChanged()](#M-DesktopMagicPluginAPI-Inputs-Element-ValueChanged 'DesktopMagicPluginAPI.Inputs.Element.ValueChanged')
|
||||
- [ElementAttribute](#T-DesktopMagicPluginAPI-Inputs-ElementAttribute 'DesktopMagicPluginAPI.Inputs.ElementAttribute')
|
||||
- [#ctor(name,orderIndex)](#M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor-System-String,System-Int32- 'DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor(System.String,System.Int32)')
|
||||
- [#ctor(orderIndex)](#M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor-System-Int32- 'DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor(System.Int32)')
|
||||
- [#ctor()](#M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor 'DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor')
|
||||
- [Name](#P-DesktopMagicPluginAPI-Inputs-ElementAttribute-Name 'DesktopMagicPluginAPI.Inputs.ElementAttribute.Name')
|
||||
- [OrderIndex](#P-DesktopMagicPluginAPI-Inputs-ElementAttribute-OrderIndex 'DesktopMagicPluginAPI.Inputs.ElementAttribute.OrderIndex')
|
||||
- [IPluginData](#T-DesktopMagicPluginAPI-IPluginData 'DesktopMagicPluginAPI.IPluginData')
|
||||
- [Color](#P-DesktopMagicPluginAPI-IPluginData-Color 'DesktopMagicPluginAPI.IPluginData.Color')
|
||||
- [Font](#P-DesktopMagicPluginAPI-IPluginData-Font 'DesktopMagicPluginAPI.IPluginData.Font')
|
||||
- [WindowPosition](#P-DesktopMagicPluginAPI-IPluginData-WindowPosition 'DesktopMagicPluginAPI.IPluginData.WindowPosition')
|
||||
- [WindowSize](#P-DesktopMagicPluginAPI-IPluginData-WindowSize 'DesktopMagicPluginAPI.IPluginData.WindowSize')
|
||||
- [UpdateWindow()](#M-DesktopMagicPluginAPI-IPluginData-UpdateWindow 'DesktopMagicPluginAPI.IPluginData.UpdateWindow')
|
||||
- [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown')
|
||||
- [#ctor(min,max,value)](#M-DesktopMagicPluginAPI-Inputs-IntegerUpDown-#ctor-System-Int32,System-Int32,System-Int32- 'DesktopMagicPluginAPI.Inputs.IntegerUpDown.#ctor(System.Int32,System.Int32,System.Int32)')
|
||||
- [Maximum](#P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Maximum 'DesktopMagicPluginAPI.Inputs.IntegerUpDown.Maximum')
|
||||
- [Minimum](#P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Minimum 'DesktopMagicPluginAPI.Inputs.IntegerUpDown.Minimum')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Value 'DesktopMagicPluginAPI.Inputs.IntegerUpDown.Value')
|
||||
- [Label](#T-DesktopMagicPluginAPI-Inputs-Label 'DesktopMagicPluginAPI.Inputs.Label')
|
||||
- [#ctor(value,bold)](#M-DesktopMagicPluginAPI-Inputs-Label-#ctor-System-String,System-Boolean- 'DesktopMagicPluginAPI.Inputs.Label.#ctor(System.String,System.Boolean)')
|
||||
- [Bold](#P-DesktopMagicPluginAPI-Inputs-Label-Bold 'DesktopMagicPluginAPI.Inputs.Label.Bold')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-Label-Value 'DesktopMagicPluginAPI.Inputs.Label.Value')
|
||||
- [Plugin](#T-DesktopMagicPluginAPI-Plugin 'DesktopMagicPluginAPI.Plugin')
|
||||
- [Application](#P-DesktopMagicPluginAPI-Plugin-Application 'DesktopMagicPluginAPI.Plugin.Application')
|
||||
- [UpdateInterval](#P-DesktopMagicPluginAPI-Plugin-UpdateInterval 'DesktopMagicPluginAPI.Plugin.UpdateInterval')
|
||||
- [Main()](#M-DesktopMagicPluginAPI-Plugin-Main 'DesktopMagicPluginAPI.Plugin.Main')
|
||||
- [OnMouseClick(position)](#M-DesktopMagicPluginAPI-Plugin-OnMouseClick-System-Drawing-Point- 'DesktopMagicPluginAPI.Plugin.OnMouseClick(System.Drawing.Point)')
|
||||
- [OnMouseMove(position)](#M-DesktopMagicPluginAPI-Plugin-OnMouseMove-System-Drawing-Point- 'DesktopMagicPluginAPI.Plugin.OnMouseMove(System.Drawing.Point)')
|
||||
- [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider')
|
||||
- [#ctor(min,max,value)](#M-DesktopMagicPluginAPI-Inputs-Slider-#ctor-System-Double,System-Double,System-Double- 'DesktopMagicPluginAPI.Inputs.Slider.#ctor(System.Double,System.Double,System.Double)')
|
||||
- [Maximum](#P-DesktopMagicPluginAPI-Inputs-Slider-Maximum 'DesktopMagicPluginAPI.Inputs.Slider.Maximum')
|
||||
- [Minimum](#P-DesktopMagicPluginAPI-Inputs-Slider-Minimum 'DesktopMagicPluginAPI.Inputs.Slider.Minimum')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-Slider-Value 'DesktopMagicPluginAPI.Inputs.Slider.Value')
|
||||
- [TextBox](#T-DesktopMagicPluginAPI-Inputs-TextBox 'DesktopMagicPluginAPI.Inputs.TextBox')
|
||||
- [#ctor(value)](#M-DesktopMagicPluginAPI-Inputs-TextBox-#ctor-System-String- 'DesktopMagicPluginAPI.Inputs.TextBox.#ctor(System.String)')
|
||||
- [Value](#P-DesktopMagicPluginAPI-Inputs-TextBox-Value 'DesktopMagicPluginAPI.Inputs.TextBox.Value')
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-Button'></a>
|
||||
## Button `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a button control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Button-#ctor-System-String-'></a>
|
||||
### #ctor(value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [Button](#T-DesktopMagicPluginAPI-Inputs-Button 'DesktopMagicPluginAPI.Inputs.Button') class with the provided `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| value | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The text caption displayed in the [Button](#T-DesktopMagicPluginAPI-Inputs-Button 'DesktopMagicPluginAPI.Inputs.Button') control. |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Button-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the text caption displayed in the [Button](#T-DesktopMagicPluginAPI-Inputs-Button 'DesktopMagicPluginAPI.Inputs.Button') element.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Button-Click'></a>
|
||||
### Click() `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Triggers the [](#E-DesktopMagicPluginAPI-Inputs-Button-OnClick 'DesktopMagicPluginAPI.Inputs.Button.OnClick') event.
|
||||
|
||||
##### Parameters
|
||||
|
||||
This method has no parameters.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-CheckBox'></a>
|
||||
## CheckBox `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a check box control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-CheckBox-#ctor-System-Boolean-'></a>
|
||||
### #ctor(value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [CheckBox](#T-DesktopMagicPluginAPI-Inputs-CheckBox 'DesktopMagicPluginAPI.Inputs.CheckBox') class with the provided `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| value | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | A value indicating whether the [CheckBox](#T-DesktopMagicPluginAPI-Inputs-CheckBox 'DesktopMagicPluginAPI.Inputs.CheckBox') is in the checked state. |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-CheckBox-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or set a value indicating whether the [CheckBox](#T-DesktopMagicPluginAPI-Inputs-CheckBox 'DesktopMagicPluginAPI.Inputs.CheckBox') is in the checked state.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-Element'></a>
|
||||
## Element `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
The element base class
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Element-ValueChanged'></a>
|
||||
### ValueChanged() `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Triggers the [](#E-DesktopMagicPluginAPI-Inputs-Element-OnValueChanged 'DesktopMagicPluginAPI.Inputs.Element.OnValueChanged') event
|
||||
|
||||
##### Parameters
|
||||
|
||||
This method has no parameters.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-ElementAttribute'></a>
|
||||
## ElementAttribute `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Marks a Property as element.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor-System-String,System-Int32-'></a>
|
||||
### #ctor(name,orderIndex) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Marks a Property as element with the provided `name` and `orderIndex`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| name | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The name of the element. |
|
||||
| orderIndex | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The order index of the element. |
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor-System-Int32-'></a>
|
||||
### #ctor(orderIndex) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Marks a Property as element with the provided `orderIndex`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| orderIndex | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The order index of the element. |
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-ElementAttribute-#ctor'></a>
|
||||
### #ctor() `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
*Inherit from parent.*
|
||||
|
||||
##### Parameters
|
||||
|
||||
This constructor has no parameters.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-ElementAttribute-Name'></a>
|
||||
### Name `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
The name of the element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-ElementAttribute-OrderIndex'></a>
|
||||
### OrderIndex `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
The order index of the element.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-IPluginData'></a>
|
||||
## IPluginData `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI
|
||||
|
||||
##### Summary
|
||||
|
||||
Defines properties and methods that provide information about the main application.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-IPluginData-Color'></a>
|
||||
### Color `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets the color of the main application.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-IPluginData-Font'></a>
|
||||
### Font `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets the font of the main application.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-IPluginData-WindowPosition'></a>
|
||||
### WindowPosition `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets the window position of the main application.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-IPluginData-WindowSize'></a>
|
||||
### WindowSize `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets the window size of the main application.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-IPluginData-UpdateWindow'></a>
|
||||
### UpdateWindow() `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Updates the plugin window
|
||||
|
||||
##### Parameters
|
||||
|
||||
This method has no parameters.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-IntegerUpDown'></a>
|
||||
## IntegerUpDown `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a up-down control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-IntegerUpDown-#ctor-System-Int32,System-Int32,System-Int32-'></a>
|
||||
### #ctor(min,max,value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') class with the provided `min` value, `max` value and `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| min | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The maximum value for the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element. |
|
||||
| max | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The minimum value for the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element. |
|
||||
| value | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The value assigned to the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element. |
|
||||
|
||||
##### Exceptions
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| [System.ArgumentException](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.ArgumentException 'System.ArgumentException') | |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Maximum'></a>
|
||||
### Maximum `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the maximum value for the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Minimum'></a>
|
||||
### Minimum `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the minimum value for the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-IntegerUpDown-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the value assigned to the [IntegerUpDown](#T-DesktopMagicPluginAPI-Inputs-IntegerUpDown 'DesktopMagicPluginAPI.Inputs.IntegerUpDown') element.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-Label'></a>
|
||||
## Label `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a label control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Label-#ctor-System-String,System-Boolean-'></a>
|
||||
### #ctor(value,bold) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [Label](#T-DesktopMagicPluginAPI-Inputs-Label 'DesktopMagicPluginAPI.Inputs.Label') class with the provided `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| value | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | |
|
||||
| bold | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Label-Bold'></a>
|
||||
### Bold `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or set a value indicating whether the content of the [Label](#T-DesktopMagicPluginAPI-Inputs-Label 'DesktopMagicPluginAPI.Inputs.Label') is bold or not.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Label-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the text associated with this control.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Plugin'></a>
|
||||
## Plugin `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI
|
||||
|
||||
##### Summary
|
||||
|
||||
The plugin class
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Plugin-Application'></a>
|
||||
### Application `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Informations about the main application
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Plugin-UpdateInterval'></a>
|
||||
### UpdateInterval `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the interval, expressed in milliseconds, at which to call the [Main](#M-DesktopMagicPluginAPI-Plugin-Main 'DesktopMagicPluginAPI.Plugin.Main') method.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Plugin-Main'></a>
|
||||
### Main() `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Occurs when the [UpdateInterval](#P-DesktopMagicPluginAPI-Plugin-UpdateInterval 'DesktopMagicPluginAPI.Plugin.UpdateInterval') elapses.
|
||||
|
||||
##### Returns
|
||||
|
||||
|
||||
|
||||
##### Parameters
|
||||
|
||||
This method has no parameters.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Plugin-OnMouseClick-System-Drawing-Point-'></a>
|
||||
### OnMouseClick(position) `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Occurs when the window is clicked by the mouse.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| position | [System.Drawing.Point](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Drawing.Point 'System.Drawing.Point') | |
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Plugin-OnMouseMove-System-Drawing-Point-'></a>
|
||||
### OnMouseMove(position) `method`
|
||||
|
||||
##### Summary
|
||||
|
||||
Occurs when the mouse pointer is moved over the control.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| position | [System.Drawing.Point](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Drawing.Point 'System.Drawing.Point') | |
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-Slider'></a>
|
||||
## Slider `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a slider control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-Slider-#ctor-System-Double,System-Double,System-Double-'></a>
|
||||
### #ctor(min,max,value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') class with the provided `min` value, `max` value and `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| min | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | The maximum value for the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element. |
|
||||
| max | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | The minimum value for the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element. |
|
||||
| value | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | The value assigned to the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element. |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Slider-Maximum'></a>
|
||||
### Maximum `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the maximum value for the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Slider-Minimum'></a>
|
||||
### Minimum `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the minimum value for the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element.
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-Slider-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the value assigned to the [Slider](#T-DesktopMagicPluginAPI-Inputs-Slider 'DesktopMagicPluginAPI.Inputs.Slider') element.
|
||||
|
||||
<a name='T-DesktopMagicPluginAPI-Inputs-TextBox'></a>
|
||||
## TextBox `type`
|
||||
|
||||
##### Namespace
|
||||
|
||||
DesktopMagicPluginAPI.Inputs
|
||||
|
||||
##### Summary
|
||||
|
||||
Represents a text box control.
|
||||
|
||||
<a name='M-DesktopMagicPluginAPI-Inputs-TextBox-#ctor-System-String-'></a>
|
||||
### #ctor(value) `constructor`
|
||||
|
||||
##### Summary
|
||||
|
||||
Initializes a new instance of the [TextBox](#T-DesktopMagicPluginAPI-Inputs-TextBox 'DesktopMagicPluginAPI.Inputs.TextBox') class with the provided `value`.
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| value | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | |
|
||||
|
||||
<a name='P-DesktopMagicPluginAPI-Inputs-TextBox-Value'></a>
|
||||
### Value `property`
|
||||
|
||||
##### Summary
|
||||
|
||||
Gets or sets the text associated with this control.
|
||||
@@ -0,0 +1,254 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>DesktopMagicPluginAPI</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:DesktopMagicPluginAPI.Inputs.Button">
|
||||
<summary>
|
||||
Represents a button control.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="E:DesktopMagicPluginAPI.Inputs.Button.OnClick">
|
||||
<summary>
|
||||
Occurs when the button is clicked.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.Button.Value">
|
||||
<summary>
|
||||
Gets or sets the text caption displayed in the <see cref="T:DesktopMagicPluginAPI.Inputs.Button"/> element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.Button.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.Button"/> class with the provided <paramref name="value"/>.
|
||||
</summary>
|
||||
<param name="value">The text caption displayed in the <see cref="T:DesktopMagicPluginAPI.Inputs.Button"/> control.</param>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.Button.Click">
|
||||
<summary>
|
||||
Triggers the <see cref="E:DesktopMagicPluginAPI.Inputs.Button.OnClick"/> event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.Inputs.CheckBox">
|
||||
<summary>
|
||||
Represents a check box control.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.CheckBox.Value">
|
||||
<summary>
|
||||
Gets or set a value indicating whether the <see cref="T:DesktopMagicPluginAPI.Inputs.CheckBox"/> is in the checked state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.CheckBox.#ctor(System.Boolean)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.CheckBox"/> class with the provided <paramref name="value"/>.
|
||||
</summary>
|
||||
<param name="value">A value indicating whether the <see cref="T:DesktopMagicPluginAPI.Inputs.CheckBox"/> is in the checked state.</param>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.Inputs.Element">
|
||||
<summary>
|
||||
The element base class
|
||||
</summary>
|
||||
</member>
|
||||
<member name="E:DesktopMagicPluginAPI.Inputs.Element.OnValueChanged">
|
||||
<summary>
|
||||
Occurs when the value has been changed
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.Element.ValueChanged">
|
||||
<summary>
|
||||
Triggers the <see cref="E:DesktopMagicPluginAPI.Inputs.Element.OnValueChanged"/> event
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.Inputs.ElementAttribute">
|
||||
<summary>
|
||||
Marks a Property as element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.ElementAttribute.Name">
|
||||
<summary>
|
||||
The name of the element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.ElementAttribute.OrderIndex">
|
||||
<summary>
|
||||
The order index of the element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor(System.String,System.Int32)">
|
||||
<summary>
|
||||
Marks a Property as element with the provided <paramref name="name"/> and <paramref name="orderIndex"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the element.</param>
|
||||
<param name="orderIndex">The order index of the element.</param>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor(System.Int32)">
|
||||
<summary>
|
||||
Marks a Property as element with the provided <paramref name="orderIndex"/>.
|
||||
</summary>
|
||||
<param name="orderIndex">The order index of the element.</param>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor">
|
||||
<inheritdoc cref="T:DesktopMagicPluginAPI.Inputs.ElementAttribute"/>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown">
|
||||
<summary>
|
||||
Represents a up-down control.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.IntegerUpDown.Maximum">
|
||||
<summary>
|
||||
Gets or sets the maximum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.IntegerUpDown.Minimum">
|
||||
<summary>
|
||||
Gets or sets the minimum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.IntegerUpDown.Value">
|
||||
<summary>
|
||||
Gets or sets the value assigned to the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.IntegerUpDown.#ctor(System.Int32,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> class with the provided <paramref name="min"/> value, <paramref name="max"/> value and <paramref name="value"/>.
|
||||
</summary>
|
||||
<param name="min">The maximum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.</param>
|
||||
<param name="max">The minimum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.</param>
|
||||
<param name="value">The value assigned to the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.</param>
|
||||
<exception cref="T:System.ArgumentException"></exception>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.Inputs.Label">
|
||||
<summary>
|
||||
Represents a label control.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.Label.Value">
|
||||
<summary>
|
||||
Gets or sets the text associated with this control.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.Label.Bold">
|
||||
<summary>
|
||||
Gets or set a value indicating whether the content of the <see cref="T:DesktopMagicPluginAPI.Inputs.Label"/> is bold or not.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.Label.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.Label"/> class with the provided <paramref name="value"/>.
|
||||
</summary>
|
||||
<param name="value"></param>
|
||||
<param name="bold"></param>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.Inputs.Slider">
|
||||
<summary>
|
||||
Represents a slider control.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.Slider.Maximum">
|
||||
<summary>
|
||||
Gets or sets the maximum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.Slider.Minimum">
|
||||
<summary>
|
||||
Gets or sets the minimum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.Slider.Value">
|
||||
<summary>
|
||||
Gets or sets the value assigned to the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.Slider.#ctor(System.Double,System.Double,System.Double)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> class with the provided <paramref name="min"/> value, <paramref name="max"/> value and <paramref name="value"/>.
|
||||
</summary>
|
||||
<param name="min">The maximum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.</param>
|
||||
<param name="max">The minimum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.</param>
|
||||
<param name="value">The value assigned to the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.</param>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.Inputs.TextBox">
|
||||
<summary>
|
||||
Represents a text box control.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Inputs.TextBox.Value">
|
||||
<summary>
|
||||
Gets or sets the text associated with this control.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Inputs.TextBox.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.TextBox"/> class with the provided <paramref name="value"/>.
|
||||
</summary>
|
||||
<param name="value"></param>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.IPluginData">
|
||||
<summary>
|
||||
Defines properties and methods that provide information about the main application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.IPluginData.Font">
|
||||
<summary>
|
||||
Gets the font of the main application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.IPluginData.Color">
|
||||
<summary>
|
||||
Gets the color of the main application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.IPluginData.WindowSize">
|
||||
<summary>
|
||||
Gets the window size of the main application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.IPluginData.WindowPosition">
|
||||
<summary>
|
||||
Gets the window position of the main application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.IPluginData.UpdateWindow">
|
||||
<summary>
|
||||
Updates the plugin window
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:DesktopMagicPluginAPI.Plugin">
|
||||
<summary>
|
||||
The plugin class
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Plugin.Application">
|
||||
<summary>
|
||||
Informations about the main application
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DesktopMagicPluginAPI.Plugin.UpdateInterval">
|
||||
<summary>
|
||||
Gets or sets the interval, expressed in milliseconds, at which to call the <see cref="M:DesktopMagicPluginAPI.Plugin.Main"/> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Plugin.Main">
|
||||
<summary>
|
||||
Occurs when the <see cref="P:DesktopMagicPluginAPI.Plugin.UpdateInterval"/> elapses.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Plugin.OnMouseClick(System.Drawing.Point)">
|
||||
<summary>
|
||||
Occurs when the window is clicked by the mouse.
|
||||
</summary>
|
||||
<param name="position"></param>
|
||||
</member>
|
||||
<member name="M:DesktopMagicPluginAPI.Plugin.OnMouseMove(System.Drawing.Point)">
|
||||
<summary>
|
||||
Occurs when the mouse pointer is moved over the control.
|
||||
</summary>
|
||||
<param name="position"></param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -2,13 +2,34 @@
|
||||
|
||||
namespace DesktopMagicPluginAPI
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines properties and methods that provide information about the main application.
|
||||
/// </summary>
|
||||
public interface IPluginData
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the font of the main application.
|
||||
/// </summary>
|
||||
string Font { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the color of the main application.
|
||||
/// </summary>
|
||||
Color Color { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the window size of the main application.
|
||||
/// </summary>
|
||||
Point WindowSize { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the window position of the main application.
|
||||
/// </summary>
|
||||
Point WindowPosition { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Updates the plugin window
|
||||
/// </summary>
|
||||
void UpdateWindow();
|
||||
}
|
||||
}
|
||||
@@ -6,12 +6,21 @@ using System.Threading.Tasks;
|
||||
|
||||
namespace DesktopMagicPluginAPI.Inputs
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a button control.
|
||||
/// </summary>
|
||||
public class Button : Element
|
||||
{
|
||||
/// <summary>
|
||||
/// Occurs when the button is clicked.
|
||||
/// </summary>
|
||||
public event Action OnClick;
|
||||
|
||||
private string _value;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the text caption displayed in the <see cref="Button"/> element.
|
||||
/// </summary>
|
||||
public string Value
|
||||
{
|
||||
get => _value;
|
||||
@@ -25,11 +34,18 @@ namespace DesktopMagicPluginAPI.Inputs
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Button"/> class with the provided <paramref name="value"/>.
|
||||
/// </summary>
|
||||
/// <param name="value">The text caption displayed in the <see cref="Button"/> control.</param>
|
||||
public Button(string value)
|
||||
{
|
||||
Value = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Triggers the <see cref="OnClick"/> event.
|
||||
/// </summary>
|
||||
public void Click()
|
||||
{
|
||||
OnClick?.Invoke();
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
namespace DesktopMagicPluginAPI.Inputs
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a check box control.
|
||||
/// </summary>
|
||||
public class CheckBox : Element
|
||||
{
|
||||
private bool _value;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or set a value indicating whether the <see cref="CheckBox"/> is in the checked state.
|
||||
/// </summary>
|
||||
public bool Value
|
||||
{
|
||||
get => _value;
|
||||
@@ -17,6 +23,10 @@
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="CheckBox"/> class with the provided <paramref name="value"/>.
|
||||
/// </summary>
|
||||
/// <param name="value">A value indicating whether the <see cref="CheckBox"/> is in the checked state.</param>
|
||||
public CheckBox(bool value)
|
||||
{
|
||||
Value = value;
|
||||
|
||||
@@ -2,10 +2,19 @@
|
||||
|
||||
namespace DesktopMagicPluginAPI.Inputs
|
||||
{
|
||||
/// <summary>
|
||||
/// The element base class
|
||||
/// </summary>
|
||||
public abstract class Element
|
||||
{
|
||||
/// <summary>
|
||||
/// Occurs when the value has been changed
|
||||
/// </summary>
|
||||
public event Action OnValueChanged;
|
||||
|
||||
/// <summary>
|
||||
/// Triggers the <see cref="OnValueChanged"/> event
|
||||
/// </summary>
|
||||
protected void ValueChanged()
|
||||
{
|
||||
OnValueChanged?.Invoke();
|
||||
|
||||
@@ -2,24 +2,43 @@
|
||||
|
||||
namespace DesktopMagicPluginAPI.Inputs
|
||||
{
|
||||
[AttributeUsage(AttributeTargets.Field)
|
||||
]
|
||||
/// <summary>
|
||||
/// Marks a Property as element.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Field)]
|
||||
public class ElementAttribute : Attribute
|
||||
{
|
||||
/// <summary>
|
||||
/// The name of the element.
|
||||
/// </summary>
|
||||
public string Name { get; }
|
||||
|
||||
/// <summary>
|
||||
/// The order index of the element.
|
||||
/// </summary>
|
||||
public int OrderIndex { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Marks a Property as element with the provided <paramref name="name"/> and <paramref name="orderIndex"/>.
|
||||
/// </summary>
|
||||
/// <param name="name">The name of the element.</param>
|
||||
/// <param name="orderIndex">The order index of the element.</param>
|
||||
public ElementAttribute(string name = "", int orderIndex = 0)
|
||||
{
|
||||
Name = name;
|
||||
OrderIndex = orderIndex;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Marks a Property as element with the provided <paramref name="orderIndex"/>.
|
||||
/// </summary>
|
||||
/// <param name="orderIndex">The order index of the element.</param>
|
||||
public ElementAttribute(int orderIndex = 0)
|
||||
{
|
||||
OrderIndex = orderIndex;
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="ElementAttribute"/>
|
||||
public ElementAttribute()
|
||||
{
|
||||
}
|
||||
|
||||
@@ -2,12 +2,26 @@
|
||||
|
||||
namespace DesktopMagicPluginAPI.Inputs
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a up-down control.
|
||||
/// </summary>
|
||||
public class IntegerUpDown : Element
|
||||
{
|
||||
private int _value;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the maximum value for the <see cref="IntegerUpDown"/> element.
|
||||
/// </summary>
|
||||
public int Maximum { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the minimum value for the <see cref="IntegerUpDown"/> element.
|
||||
/// </summary>
|
||||
public int Minimum { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the value assigned to the <see cref="IntegerUpDown"/> element.
|
||||
/// </summary>
|
||||
public int Value
|
||||
{
|
||||
get => _value;
|
||||
@@ -21,6 +35,13 @@ namespace DesktopMagicPluginAPI.Inputs
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="IntegerUpDown"/> class with the provided <paramref name="min"/> value, <paramref name="max"/> value and <paramref name="value"/>.
|
||||
/// </summary>
|
||||
/// <param name="min">The maximum value for the <see cref="IntegerUpDown"/> element.</param>
|
||||
/// <param name="max">The minimum value for the <see cref="IntegerUpDown"/> element.</param>
|
||||
/// <param name="value">The value assigned to the <see cref="IntegerUpDown"/> element.</param>
|
||||
/// <exception cref="ArgumentException"></exception>
|
||||
public IntegerUpDown(int min, int max, int value = 0)
|
||||
{
|
||||
if (min < 0)
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
namespace DesktopMagicPluginAPI.Inputs
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a label control.
|
||||
/// </summary>
|
||||
public class Label : Element
|
||||
{
|
||||
private string _value;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the text associated with this control.
|
||||
/// </summary>
|
||||
public string Value
|
||||
{
|
||||
get => _value;
|
||||
@@ -17,8 +23,16 @@
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or set a value indicating whether the content of the <see cref="Label"/> is bold or not.
|
||||
/// </summary>
|
||||
public bool Bold { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Label"/> class with the provided <paramref name="value"/>.
|
||||
/// </summary>
|
||||
/// <param name="value"></param>
|
||||
/// <param name="bold"></param>
|
||||
public Label(string value, bool bold = false)
|
||||
{
|
||||
Value = value;
|
||||
|
||||
@@ -2,12 +2,26 @@
|
||||
|
||||
namespace DesktopMagicPluginAPI.Inputs
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a slider control.
|
||||
/// </summary>
|
||||
public sealed class Slider : Element
|
||||
{
|
||||
private double _value;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the maximum value for the <see cref="Slider"/> element.
|
||||
/// </summary>
|
||||
public double Maximum { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the minimum value for the <see cref="Slider"/> element.
|
||||
/// </summary>
|
||||
public double Minimum { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the value assigned to the <see cref="Slider"/> element.
|
||||
/// </summary>
|
||||
public double Value
|
||||
{
|
||||
get => _value;
|
||||
@@ -21,6 +35,12 @@ namespace DesktopMagicPluginAPI.Inputs
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Slider"/> class with the provided <paramref name="min"/> value, <paramref name="max"/> value and <paramref name="value"/>.
|
||||
/// </summary>
|
||||
/// <param name="min">The maximum value for the <see cref="Slider"/> element.</param>
|
||||
/// <param name="max">The minimum value for the <see cref="Slider"/> element.</param>
|
||||
/// <param name="value">The value assigned to the <see cref="Slider"/> element.</param>
|
||||
public Slider(double min, double max, double value = 0)
|
||||
{
|
||||
if (min < 0)
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
namespace DesktopMagicPluginAPI.Inputs
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a text box control.
|
||||
/// </summary>
|
||||
public class TextBox : Element
|
||||
{
|
||||
private string _value;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the text associated with this control.
|
||||
/// </summary>
|
||||
public string Value
|
||||
{
|
||||
get => _value;
|
||||
@@ -17,6 +23,10 @@
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TextBox"/> class with the provided <paramref name="value"/>.
|
||||
/// </summary>
|
||||
/// <param name="value"></param>
|
||||
public TextBox(string value)
|
||||
{
|
||||
Value = value;
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2021 Stone_Red
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -3,10 +3,16 @@ using System.Drawing;
|
||||
|
||||
namespace DesktopMagicPluginAPI
|
||||
{
|
||||
/// <summary>
|
||||
/// The plugin class
|
||||
/// </summary>
|
||||
public abstract class Plugin
|
||||
{
|
||||
private IPluginData application = null;
|
||||
|
||||
/// <summary>
|
||||
/// Informations about the main application
|
||||
/// </summary>
|
||||
public IPluginData Application
|
||||
{
|
||||
get => application;
|
||||
@@ -23,14 +29,29 @@ namespace DesktopMagicPluginAPI
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the interval, expressed in milliseconds, at which to call the <see cref="Main"/> method.
|
||||
/// </summary>
|
||||
public virtual int UpdateInterval { get; set; } = 1000;
|
||||
|
||||
/// <summary>
|
||||
/// Occurs when the <see cref="UpdateInterval"/> elapses.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public abstract Bitmap Main();
|
||||
|
||||
/// <summary>
|
||||
/// Occurs when the window is clicked by the mouse.
|
||||
/// </summary>
|
||||
/// <param name="position"></param>
|
||||
public virtual void OnMouseClick(Point position)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Occurs when the mouse pointer is moved over the control.
|
||||
/// </summary>
|
||||
/// <param name="position"></param>
|
||||
public virtual void OnMouseMove(Point position)
|
||||
{
|
||||
}
|
||||
|
||||
@@ -8,7 +8,8 @@
|
||||
".NETCoreApp,Version=v5.0": {
|
||||
"DesktopMagicPluginAPI/0.0.0.1": {
|
||||
"dependencies": {
|
||||
"System.Drawing.Common": "5.0.2"
|
||||
"System.Drawing.Common": "5.0.2",
|
||||
"Vsxmd": "1.4.5"
|
||||
},
|
||||
"runtime": {
|
||||
"DesktopMagicPluginAPI.dll": {}
|
||||
@@ -58,7 +59,8 @@
|
||||
"fileVersion": "5.0.421.11614"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Vsxmd/1.4.5": {}
|
||||
}
|
||||
},
|
||||
"libraries": {
|
||||
@@ -87,6 +89,13 @@
|
||||
"sha512": "sha512-rvr/M1WPf24ljpvvrVd74+NdjRUJu1bBkspkZcnzSZnmAUQWSvanlQ0k/hVHk+cHufZbZfu7vOh/vYc0q5Uu/A==",
|
||||
"path": "system.drawing.common/5.0.2",
|
||||
"hashPath": "system.drawing.common.5.0.2.nupkg.sha512"
|
||||
},
|
||||
"Vsxmd/1.4.5": {
|
||||
"type": "package",
|
||||
"serviceable": true,
|
||||
"sha512": "sha512-mvTZKIhKUFvcjYv/p9dxgSFHrAlNFIemT3ai1XAFV4yJYGu/6e73NgzfHwhDi0QevuYURVdd+p088CG6KQFENg==",
|
||||
"path": "vsxmd/1.4.5",
|
||||
"hashPath": "vsxmd.1.4.5.nupkg.sha512"
|
||||
}
|
||||
}
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
+1
-1
@@ -14,7 +14,6 @@ C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\bin\Debug\ne
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\bin\Debug\net5.0\DesktopMagicPluginAPI.dll
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\bin\Debug\net5.0\ref\DesktopMagicPluginAPI.dll
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\bin\Debug\net5.0\DesktopMagicPluginAPI.pdb
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\obj\Debug\net5.0\DesktopMagicPluginAPI.csproj.AssemblyReference.cache
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\obj\Debug\net5.0\DesktopMagicPluginAPI.GeneratedMSBuildEditorConfig.editorconfig
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\obj\Debug\net5.0\DesktopMagicPluginAPI.AssemblyInfoInputs.cache
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\obj\Debug\net5.0\DesktopMagicPluginAPI.AssemblyInfo.cs
|
||||
@@ -22,3 +21,4 @@ C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\obj\Debug\ne
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\obj\Debug\net5.0\DesktopMagicPluginAPI.dll
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\obj\Debug\net5.0\ref\DesktopMagicPluginAPI.dll
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\obj\Debug\net5.0\DesktopMagicPluginAPI.pdb
|
||||
C:\Users\David\Programmieren\DesktopMagic\src\DesktopMagicPluginAPI\bin\Debug\net5.0\DesktopMagicPluginAPI.xml
|
||||
|
||||
Binary file not shown.
Binary file not shown.
@@ -48,6 +48,12 @@
|
||||
"System.Drawing.Common": {
|
||||
"target": "Package",
|
||||
"version": "[5.0.2, )"
|
||||
},
|
||||
"Vsxmd": {
|
||||
"include": "Runtime, Build, Native, ContentFiles, Analyzers, BuildTransitive",
|
||||
"suppressParent": "All",
|
||||
"target": "Package",
|
||||
"version": "[1.4.5, )"
|
||||
}
|
||||
},
|
||||
"imports": [
|
||||
@@ -65,7 +71,7 @@
|
||||
"privateAssets": "all"
|
||||
}
|
||||
},
|
||||
"runtimeIdentifierGraphPath": "C:\\Program Files\\dotnet\\sdk\\5.0.302\\RuntimeIdentifierGraph.json"
|
||||
"runtimeIdentifierGraphPath": "C:\\Program Files\\dotnet\\sdk\\5.0.303\\RuntimeIdentifierGraph.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,4 +16,7 @@
|
||||
<PropertyGroup>
|
||||
<MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
|
||||
</PropertyGroup>
|
||||
<PropertyGroup Condition=" '$(ExcludeRestorePackageImports)' != 'true' ">
|
||||
<PkgVsxmd Condition=" '$(PkgVsxmd)' == '' ">C:\Users\David\.nuget\packages\vsxmd\1.4.5</PkgVsxmd>
|
||||
</PropertyGroup>
|
||||
</Project>
|
||||
@@ -3,4 +3,7 @@
|
||||
<PropertyGroup>
|
||||
<MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
|
||||
</PropertyGroup>
|
||||
<ImportGroup Condition=" '$(ExcludeRestorePackageImports)' != 'true' ">
|
||||
<Import Project="$(NuGetPackageRoot)vsxmd\1.4.5\build\Vsxmd.targets" Condition="Exists('$(NuGetPackageRoot)vsxmd\1.4.5\build\Vsxmd.targets')" />
|
||||
</ImportGroup>
|
||||
</Project>
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -50,6 +50,12 @@
|
||||
"rid": "win"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Vsxmd/1.4.5": {
|
||||
"type": "package",
|
||||
"build": {
|
||||
"build/Vsxmd.targets": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -141,11 +147,31 @@
|
||||
"useSharedDesignerContext.txt",
|
||||
"version.txt"
|
||||
]
|
||||
},
|
||||
"Vsxmd/1.4.5": {
|
||||
"sha512": "mvTZKIhKUFvcjYv/p9dxgSFHrAlNFIemT3ai1XAFV4yJYGu/6e73NgzfHwhDi0QevuYURVdd+p088CG6KQFENg==",
|
||||
"type": "package",
|
||||
"path": "vsxmd/1.4.5",
|
||||
"hasTools": true,
|
||||
"files": [
|
||||
".nupkg.metadata",
|
||||
".signature.p7s",
|
||||
"LICENSE",
|
||||
"build/Vsxmd.targets",
|
||||
"tools/linux-musl-x64/Vsxmd",
|
||||
"tools/linux-x64/Vsxmd",
|
||||
"tools/osx-x64/Vsxmd",
|
||||
"tools/win-x64/Vsxmd.exe",
|
||||
"tools/win-x86/Vsxmd.exe",
|
||||
"vsxmd.1.4.5.nupkg.sha512",
|
||||
"vsxmd.nuspec"
|
||||
]
|
||||
}
|
||||
},
|
||||
"projectFileDependencyGroups": {
|
||||
"net5.0": [
|
||||
"System.Drawing.Common >= 5.0.2"
|
||||
"System.Drawing.Common >= 5.0.2",
|
||||
"Vsxmd >= 1.4.5"
|
||||
]
|
||||
},
|
||||
"packageFolders": {
|
||||
@@ -196,6 +222,12 @@
|
||||
"System.Drawing.Common": {
|
||||
"target": "Package",
|
||||
"version": "[5.0.2, )"
|
||||
},
|
||||
"Vsxmd": {
|
||||
"include": "Runtime, Build, Native, ContentFiles, Analyzers, BuildTransitive",
|
||||
"suppressParent": "All",
|
||||
"target": "Package",
|
||||
"version": "[1.4.5, )"
|
||||
}
|
||||
},
|
||||
"imports": [
|
||||
@@ -213,7 +245,7 @@
|
||||
"privateAssets": "all"
|
||||
}
|
||||
},
|
||||
"runtimeIdentifierGraphPath": "C:\\Program Files\\dotnet\\sdk\\5.0.302\\RuntimeIdentifierGraph.json"
|
||||
"runtimeIdentifierGraphPath": "C:\\Program Files\\dotnet\\sdk\\5.0.303\\RuntimeIdentifierGraph.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
{
|
||||
"version": 2,
|
||||
"dgSpecHash": "TFv9VaIlVM7dJlroayvqki0onWR6tqfcSvlcX48JtcAgxtEPtdStmcE1Z2n6c2FLEwd5vOPjzRiUPYC+hlGU9A==",
|
||||
"dgSpecHash": "PrK4R+l3u6JxzuOYWiCjlfnd+WV7XnD5wEgbNXGd4yrETRuwSZYzCVaO3kcGaySPvSCHzBOcoR2lQzmgUWzZEQ==",
|
||||
"success": true,
|
||||
"projectFilePath": "C:\\Users\\David\\Programmieren\\DesktopMagic\\src\\DesktopMagicPluginAPI\\DesktopMagicPluginAPI.csproj",
|
||||
"expectedPackageFiles": [
|
||||
"C:\\Users\\David\\.nuget\\packages\\microsoft.netcore.platforms\\5.0.0\\microsoft.netcore.platforms.5.0.0.nupkg.sha512",
|
||||
"C:\\Users\\David\\.nuget\\packages\\microsoft.win32.systemevents\\5.0.0\\microsoft.win32.systemevents.5.0.0.nupkg.sha512",
|
||||
"C:\\Users\\David\\.nuget\\packages\\system.drawing.common\\5.0.2\\system.drawing.common.5.0.2.nupkg.sha512"
|
||||
"C:\\Users\\David\\.nuget\\packages\\system.drawing.common\\5.0.2\\system.drawing.common.5.0.2.nupkg.sha512",
|
||||
"C:\\Users\\David\\.nuget\\packages\\vsxmd\\1.4.5\\vsxmd.1.4.5.nupkg.sha512"
|
||||
],
|
||||
"logs": []
|
||||
}
|
||||
Reference in New Issue
Block a user