Skip to content

Commit

Permalink
Merge pull request #1883 Add "X" icon to filter text boxes that clear…
Browse files Browse the repository at this point in the history
…s the control
  • Loading branch information
politas committed Sep 5, 2016
2 parents 5dc7631 + 254ed3d commit 2f448b9
Show file tree
Hide file tree
Showing 9 changed files with 305 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ All notable changes to this project will be documented in this file.
- [Core] Users are less able to run two copies of CKAN at the same time. (#1265 by: mgsdk, #1357 by pjf, #1828 by politas; reviewed: ayan4m1)
- [NetKAN] Add Curse as a $kref source (#1608 by: airminer, Olympic1; reviewed: dbent, pjf, techman83, ayan4m1)
- [All] Relationship changes now prompt reinstalling (#1730 by: dbent, #1885 by: @ayan4m1; reviewed: plague006, pjf)
- [GUI] Add "X" icon to filter text boxes that clears the control (#1883 by ayan4m1; reviewed: politas)

## v1.18.1

Expand Down
10 changes: 10 additions & 0 deletions GUI/CKAN-GUI.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,12 @@
<DependentUpon>ChooseKSPInstance.cs</DependentUpon>
</Compile>
<Compile Include="ExportOption.cs" />
<Compile Include="HintTextBox.cs">
<SubType>Component</SubType>
</Compile>
<Compile Include="HintTextBox.Designer.cs">
<DependentUpon>HintTextBox.cs</DependentUpon>
</Compile>
<Compile Include="IGUIPlugin.cs">
<SubType>Code</SubType>
</Compile>
Expand Down Expand Up @@ -181,6 +187,9 @@
<EmbeddedResource Include="ErrorDialog.resx">
<DependentUpon>ErrorDialog.cs</DependentUpon>
</EmbeddedResource>
<EmbeddedResource Include="HintTextBox.resx">
<DependentUpon>HintTextBox.cs</DependentUpon>
</EmbeddedResource>
<EmbeddedResource Include="KSPCommandLineOptionsDialog.resx">
<DependentUpon>KSPCommandLineOptionsDialog.cs</DependentUpon>
</EmbeddedResource>
Expand Down Expand Up @@ -290,5 +299,6 @@
<ItemGroup>
<Content Include="Resources\backward.png" />
<Content Include="Resources\forward.png" />
<Content Include="Resources\textClear.png" />
</ItemGroup>
</Project>
46 changes: 46 additions & 0 deletions GUI/HintTextBox.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

106 changes: 106 additions & 0 deletions GUI/HintTextBox.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
using System;
using System.Drawing;
using System.Windows.Forms;

namespace CKAN
{
/// <summary>
/// A textbox which shows a "clear text" icon on the right side
/// whenever data is present.
/// </summary>
public partial class HintTextBox : TextBox
{
private readonly PictureBox _clearIcon;

/// <summary>
/// Creates a HintTextBox object.
/// </summary>
public HintTextBox()
{
InitializeComponent();

// set up clear icon state and handlers
_clearIcon = new PictureBox()
{
BackColor = Color.Transparent,
Visible = false,
Cursor = Cursors.Hand,
Image = global::CKAN.Properties.Resources.textClear,
SizeMode = PictureBoxSizeMode.CenterImage
};

// post-instantiation setup
_clearIcon.Size = _clearIcon.Image.Size;
_clearIcon.Click += HintClearIcon_Click;

// add icon and show form
Controls.Add(_clearIcon);
_clearIcon.Parent = this;
_clearIcon.BringToFront();
}

/// <summary>
/// When the icon is clicked, reset the textbox value.
/// </summary>
/// <param name="sender">The control sending the event</param>
/// <param name="e">The event arguments</param>
private void HintClearIcon_Click(object sender, EventArgs e)
{
Text = string.Empty;
}

/// <summary>
/// Show the clear icon when the textbox has data
/// </summary>
/// <param name="sender">The control sending the event</param>
/// <param name="e">The event arguments</param>
private void HintTextBox_TextChanged(object sender, EventArgs e)
{
// sanity checks
if (!Visible || ReadOnly)
{
return;
}

_clearIcon.Visible = (TextLength > 0);
}

/// <summary>
/// Adjust the position of the clear icon regardless of control size.
/// </summary>
/// <param name="sender">The control sending the event</param>
/// <param name="e">The event arguments</param>
private void HintTextBox_SizeChanged(object sender, EventArgs e)
{
if (_clearIcon.Image == null)
{
return;
}

_clearIcon.Location = new Point(
// align with right edge of textbox minus 5px
Width - _clearIcon.Width - 5,
// need to divide these as decimals and drop back to int at the end
(int)Math.Ceiling(Height / 2d - (_clearIcon.Height / 2d))
);
}

/// <summary>
/// Intercept the low-level key press messages to catch Esc,
/// which causes the textbox to clear
/// </summary>
/// <param name="msg">Win32 Message object</param>
/// <param name="keyData">Which keys are being pressed</param>
/// <returns></returns>
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
{
if (keyData == Keys.Escape)
{
Text = "";
return true;
}

return base.ProcessCmdKey(ref msg, keyData);
}
}
}
123 changes: 123 additions & 0 deletions GUI/HintTextBox.resx
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.
Example:
... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.
mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<metadata name="$this.TrayLargeIcon" type="System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
<value>False</value>
</metadata>
</root>
10 changes: 5 additions & 5 deletions GUI/Main.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions GUI/Properties/Resources.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion GUI/Properties/Resources.resx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Expand Down Expand Up @@ -148,4 +148,7 @@
<data name="forward" type="System.Resources.ResXFileRef, System.Windows.Forms">
<value>..\Resources\forward.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
</data>
<data name="textClear" type="System.Resources.ResXFileRef, System.Windows.Forms">
<value>..\Resources\textClear.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
</data>
</root>
Binary file added GUI/Resources/textClear.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2f448b9

Please sign in to comment.