Zero Install .NET API 2.20.0
ZeroInstall.Model.Capabilities.IconCapability Class Reference

Abstract base class for capabilities that can have multiple Icons and descriptions. More...

Inheritance diagram for ZeroInstall.Model.Capabilities.IconCapability:
ZeroInstall.Model.Capabilities.DefaultCapability ZeroInstall.Model.IIconContainer ZeroInstall.Model.IDescriptionContainer ZeroInstall.Model.Capabilities.Capability ZeroInstall.Model.XmlUnknown NanoByte.Common.ICloneable< Capability > ZeroInstall.Model.Capabilities.AutoPlay ZeroInstall.Model.Capabilities.VerbCapability ZeroInstall.Model.Capabilities.ContextMenu ZeroInstall.Model.Capabilities.DefaultProgram ZeroInstall.Model.Capabilities.FileType ZeroInstall.Model.Capabilities.UrlProtocol

Public Member Functions

IconGetIcon (string mimeType)
 Returns the first icon with a specific MIME type. More...
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.Capabilities.DefaultCapability
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.Capabilities.Capability
virtual void Normalize ()
 Converts legacy elements, sets default values, etc.. More...
 
abstract Capability Clone ()
 Creates a deep copy of this Capability instance. More...
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.XmlUnknown
string ToShortXml ()
 Returns a shortened XML representation (with attributes but without child elements). More...
 
override int GetHashCode ()
 
- Public Member Functions inherited from NanoByte.Common.ICloneable< Capability >
Capability Clone ()
 

Protected Member Functions

bool Equals (IconCapability? other)
 
- Protected Member Functions inherited from ZeroInstall.Model.Capabilities.DefaultCapability
bool Equals (DefaultCapability? other)
 
- Protected Member Functions inherited from ZeroInstall.Model.Capabilities.Capability
bool Equals (Capability? other)
 
- Protected Member Functions inherited from ZeroInstall.Model.XmlUnknown
void EnsureAttribute (object? value, string attributeName)
 Ensures that a value deserialized from an XML attribute is set (not null). More...
 
void EnsureAttributeSafeID (string? value, string attributeName)
 Ensures that a value deserialized from an XML attribute is set (not null) and only contains alphanumeric characters, spaces ( ), dots (.), underscores (_), hyphens (-) and plus signs (+). More...
 
bool Equals (XmlUnknown? other)
 

Properties

LocalizableStringCollection Descriptions = new() [get]
 
List< IconIcons = new() [get]
 Zero or more icons to represent the capability. Used for things like file icons.
 
- Properties inherited from ZeroInstall.Model.Capabilities.DefaultCapability
bool ExplicitOnly [getset]
 When set to true this capability is not applied as a default handler without explicit confirmation from the user. More...
 
- Properties inherited from ZeroInstall.Model.Capabilities.Capability
virtual bool WindowsMachineWideOnly [get]
 Indicates whether this capability can be registered only machine-wide and not per-user on Windows systems.
 
string ID = default! [getset]
 An ID that differentiates this capability from other capabilities of the same type within the feed. May only contain alphanumeric characters, spaces ( ), dots (.), underscores (_), hyphens (-) and plus signs (+). More...
 
abstract IEnumerable< string > ConflictIDs [get]
 Identifiers from a namespace global to all Capabilitys. Collisions in this namespace indicate that the concerned Capabilitys are in conflict cannot be registered on a single system at the same time. More...
 
- Properties inherited from ZeroInstall.Model.IIconContainer
List< IconIcons [get]
 Zero or more icons.
 
- Properties inherited from ZeroInstall.Model.IDescriptionContainer
LocalizableStringCollection Descriptions [get]
 Full descriptions for different languages, which can be several paragraphs long.
 

Additional Inherited Members

- Public Attributes inherited from ZeroInstall.Model.XmlUnknown
XmlAttribute?[] UnknownAttributes
 Contains any unknown additional XML attributes.
 
XmlElement?[] UnknownElements
 Contains any unknown additional XML elements.
 

Detailed Description

Abstract base class for capabilities that can have multiple Icons and descriptions.

Member Function Documentation

◆ GetIcon()

Icon? ZeroInstall.Model.Capabilities.IconCapability.GetIcon ( string  mimeType)
inline

Returns the first icon with a specific MIME type.

Parameters
mimeTypeThe Icon.MimeType to try to find. Will only return exact matches.
Returns
The best matching icon that was found or null if no matching icon was found.

The documentation for this class was generated from the following file: