Zero Install .NET API 2.20.0
ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry Class Reference

Creates an entry for an application in the user's application menu (i.e. Windows start menu, GNOME application menu, etc.). More...

Inheritance diagram for ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry:
ZeroInstall.DesktopIntegration.AccessPoints.IconAccessPoint ZeroInstall.DesktopIntegration.AccessPoints.CommandAccessPoint ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint ZeroInstall.Model.XmlUnknown NanoByte.Common.ICloneable< AccessPoint >

Public Member Functions

override IEnumerable< string > GetConflictIDs (AppEntry appEntry)
 Retrieves identifiers from a namespace global to all AccessPoints. Collisions in this namespace indicate that the respective AccessPoints are in conflict cannot be applied on a system at the same time. More...
 
override void Apply (AppEntry appEntry, Feed feed, IIconStore iconStore, bool machineWide)
 Applies this access point to the current machine. More...
 
override void Unapply (AppEntry appEntry, bool machineWide)
 Unapply this access point on the current machine. More...
 
override AccessPoint Clone ()
 Creates a deep copy of this AccessPoint instance. More...
 
bool Equals (MenuEntry? other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.DesktopIntegration.AccessPoints.CommandAccessPoint
override string ToString ()
 Returns the access point in the form "AccessPointType: Name (Command)". Not safe for parsing!
 
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< AccessPoint >
AccessPoint Clone ()
 

Static Public Attributes

const string CategoryName = "menu"
 The name of this category of AccessPoints as used by command-line interfaces.
 

Properties

string? Category [getset]
 The category or folder in the menu to add the entry to. Leave empty for top-level entry.
 
- Properties inherited from ZeroInstall.DesktopIntegration.AccessPoints.CommandAccessPoint
string? Name [getset]
 The name of the menu entry, icon, command-line, etc..
 
string? Command [getset]
 The name of the Model.Command to use when launching via this access point. Leave empty to use default.
 

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.
 
- Protected Member Functions inherited from ZeroInstall.DesktopIntegration.AccessPoints.CommandAccessPoint
void ValidateName ()
 Ensures that the given name can be used as a file name. More...
 
bool Equals (CommandAccessPoint? 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)
 

Detailed Description

Creates an entry for an application in the user's application menu (i.e. Windows start menu, GNOME application menu, etc.).

Member Function Documentation

◆ Apply()

override void ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry.Apply ( AppEntry  appEntry,
Feed  feed,
IIconStore  iconStore,
bool  machineWide 
)
inlinevirtual

Applies this access point to the current machine.

Implements ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint.

◆ Clone()

override AccessPoint ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry.Clone ( )
virtual

Creates a deep copy of this AccessPoint instance.

Implements ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint.

◆ GetConflictIDs()

override IEnumerable< string > ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry.GetConflictIDs ( AppEntry  appEntry)
virtual

Retrieves identifiers from a namespace global to all AccessPoints. Collisions in this namespace indicate that the respective AccessPoints are in conflict cannot be applied on a system at the same time.

Implements ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint.

◆ Unapply()

override void ZeroInstall.DesktopIntegration.AccessPoints.MenuEntry.Unapply ( AppEntry  appEntry,
bool  machineWide 
)
inlinevirtual

Unapply this access point on the current machine.

Implements ZeroInstall.DesktopIntegration.AccessPoints.AccessPoint.


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