Glyph Control (Source Control VSPackage)
For the latest documentation on Visual Studio 2017, see Visual Studio 2017 Documentation.
Part of the deep integration available to source control VSPackages is the ability to display their own glyphs to indicate the status of items under source control.
A state glyph is an icon that indicates the current status of an item when displayed, for example in Solution Explorer or in Class View. A source control VSPackage can exercise two levels of glyph control. It can limit the choice of glyphs to a predefined set of glyphs provided by the Visual Studio IDE, or it can define a custom set of glyphs to be displayed.
To determine the state glyphs that are associated with an item in Solution Explorer, a project requests the state glyph from source control using the GetSccGlyph. A source control VSPackage may decide to keep the choice of glyphs limited to predefined glyphs provided by the IDE. In this case, the VSPackage passes back an array of values representing the glyph enumerations that are defined in vsshell.idl. For more information, see VsStateIcon .This is a predefined set of glyphs set by the IDE, such as a padlock for the "Checked In" glyph, and a check mark as the "Checked Out" glyph.
A source control VSPackage can use its own glyphs for a unique "look and feel" when it is installed. When a new source control VSPackage is active, it should be able to start using its own glyphs even if a previous source control VSPackage is still loaded but inactive. In this mode, the source control VSPackage still can use the existing icons in order to maintain a look consistent with Visual Studio if it chooses.
The SVsSccManager service supports an interface, IVsSccGlyphs, which the VSPackage can optionally implement and which will be asked for by the IDE. When the IDE makes a request, Visual Studio will in turn try to get this interface from the currently registered source control VSPackage. If the interface exists in the registered VSPackage, the IDE's request for custom glyphs succeeds; otherwise, the Visual Studio IDE uses its default set of glyphs.
The GetCustomGlyphList method is used by Visual Studio to obtain a list of images showing various source control states. The source control VSPackage returns to the IDE a handle to the image list for its custom glyphs. The IDE makes a copy of the image list at this point and uses it later to choose the glyphs to display. If the new interface is not supported or the
IVsSccGlyphs::GetCustomGlyphList method returns E_NOTIMPL, then the IDE gets its glyphs from the default list of glyphs supplied by Visual Studio.