2 * Copyright (c) 2007-2010 SlimDX Group
\r
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
\r
5 * of this software and associated documentation files (the "Software"), to deal
\r
6 * in the Software without restriction, including without limitation the rights
\r
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
\r
8 * copies of the Software, and to permit persons to whom the Software is
\r
9 * furnished to do so, subject to the following conditions:
\r
11 * The above copyright notice and this permission notice shall be included in
\r
12 * all copies or substantial portions of the Software.
\r
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
\r
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
\r
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
\r
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
\r
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
\r
31 /// Contains information about the battery of an XInput device.
\r
33 /// <unmanaged>XINPUT_BATTERY_INFORMATION</unmanaged>
\r
34 public value class BatteryInformation : System::IEquatable<BatteryInformation>
\r
38 BatteryLevel m_Level;
\r
41 BatteryInformation( const XINPUT_BATTERY_INFORMATION& native );
\r
45 /// Gets the type of the battery.
\r
47 property BatteryType Type
\r
53 /// Gets the relative charge level of the battery.
\r
55 property BatteryLevel Level
\r
61 /// Tests for equality between two objects.
\r
63 /// <param name="left">The first value to compare.</param>
\r
64 /// <param name="right">The second value to compare.</param>
\r
65 /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
\r
66 static bool operator == ( BatteryInformation left, BatteryInformation right );
\r
69 /// Tests for inequality between two objects.
\r
71 /// <param name="left">The first value to compare.</param>
\r
72 /// <param name="right">The second value to compare.</param>
\r
73 /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
\r
74 static bool operator != ( BatteryInformation left, BatteryInformation right );
\r
77 /// Returns the hash code for this instance.
\r
79 /// <returns>A 32-bit signed integer hash code.</returns>
\r
80 virtual int GetHashCode() override;
\r
83 /// Returns a value that indicates whether the current instance is equal to a specified object.
\r
85 /// <param name="obj">Object to make the comparison with.</param>
\r
86 /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
\r
87 virtual bool Equals( System::Object^ obj ) override;
\r
90 /// Returns a value that indicates whether the current instance is equal to the specified object.
\r
92 /// <param name="other">Object to make the comparison with.</param>
\r
93 /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
\r
94 virtual bool Equals( BatteryInformation other );
\r
97 /// Determines whether the specified object instances are considered equal.
\r
99 /// <param name="value1">The first value to compare.</param>
\r
100 /// <param name="value2">The second value to compare.</param>
\r
101 /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or
\r
102 /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
\r
103 static bool Equals( BatteryInformation% value1, BatteryInformation% value2 );
\r