Skip to content

Commit 7131c22

Browse files
committed
Remove old icon documentation
1 parent f0fc08a commit 7131c22

File tree

11 files changed

+4
-455
lines changed

11 files changed

+4
-455
lines changed

rsd.tree

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -512,16 +512,9 @@
512512
<toc-element toc-title="Custom products"/>
513513
</toc-element>
514514
<toc-element toc-title="Misc Topics">
515-
<toc-element id="IconTypes.md"
516-
accepts-web-file-names="Platform/Shell/Icons/IconTypes.html"/>
517-
<toc-element id="Theming_Icons.md"/>
518515
<toc-element id="QuickDoc_Testing.md"/>
519-
<toc-element id="ConsumingIcons.md"
520-
accepts-web-file-names="Platform/Shell/Icons/ConsumingIcons.html"/>
521516
<toc-element id="TreeNodes.md"
522517
accepts-web-file-names="PSI/Reference/Xml/TreeNodes.html"/>
523-
<toc-element id="CreatingCompiledIcons.md"
524-
accepts-web-file-names="Platform/Shell/Icons/CreatingCompiledIcons.html"/>
525518
<toc-element id="ElementFactories.md"
526519
accepts-web-file-names="PSI/Reference/Xml/ElementFactories.html"/>
527520
<toc-element id="Zones_Troubleshooting.md"/>
@@ -540,11 +533,8 @@
540533
<toc-element id="Xml_Overview.md"/>
541534
<toc-element id="Manipulation.md"
542535
accepts-web-file-names="PSI/Reference/Xml/Manipulation.html"/>
543-
<toc-element id="Shell_Icons.md"/>
544536
<toc-element id="Licensing.md"
545537
accepts-web-file-names="Platform/Zones/Licensing.html"/>
546-
<toc-element id="CustomIconTypes.md"
547-
accepts-web-file-names="Platform/Shell/Icons/CustomIconTypes.html"/>
548538
<toc-element id="CustomHives.md"
549539
accepts-web-file-names="Platform/VisualStudio/CustomHives.html"/>
550540
<toc-element id="ImplementingProvider.md"

topics/CustomLanguages/Registration/ProjectFileLanguageService.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public interface IProjectFileLanguageService
2121
The members are as follows:
2222

2323
* **`LanguageType`** - confusingly called `LanguageType`, this is the singleton instance of the derived `ProjectFileType` class that represents the [Project Model file type](ProjectFileType.md) of this language.
24-
* **`Icon`** - the `IconId` of the icon used to represent this file. This is used whenever ReSharper needs to display the icon for a file of this type, such as in the Find Results tool window. See the section on [icons](Shell_Icons.md) for more details on icons.
24+
* **`Icon`** - the `IconId` of the icon used to represent this file. This is used whenever ReSharper needs to display the icon for a file of this type, such as in the Find Results tool window. See the section on [icons](Platform__Icons.md) for more details on icons.
2525
* **`GetPreprocessorDefines`** - retrieves a list of preprocessor symbols that are defined for the current project, as this affects the parsing of the PSI tree. This is typically only required for compiled languages in a project where the project itself has a specific language, e.g. a C# project.
2626

2727
## The GetPsiLanguageType method

topics/Features/OptionsPages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `OptionsPage` attribute requires the plugin author to provide the following
1616

1717
* The page ID. This ID can be specified as a constant field inside the class. The page ID is a string which uniquely identifies this particular options page.
1818
* The name of the page. This is the text that will appear in the left-hand tree on the Options page as well as in the title and navigation elements.
19-
* The image. This refers to the glyph that appears next to the item in the tree and is specified as a type (e.g., `typeof(OptionsPageThemedIcons.SamplePage)`). See [Icons](Shell_Icons.md) for more information.
19+
* The image. This refers to the glyph that appears next to the item in the tree and is specified as a type (e.g., `typeof(OptionsPageThemedIcons.SamplePage)`). See [Icons](Platform__Icons.md) for more information.
2020

2121
In addition, you may specify the following optional parameters:
2222

topics/PSI/PSI_Icons.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The PSI needs to be able to display icons to help identify code elements in completion, navigation or find usage result lists. The PSI can display different icons to distinguish between classes, constructors, methods, parameters, etc. It can also show specific icons for CSS class IDs, HTML elements and unit test elements.
44

5-
While the [Shell provides the `ThemedIconManager` class](Shell_Icons.md) in order to load and create icons, it is a low level API. It provides no means for getting the icon for a class, other than explicitly loading `PsiSymbolsThemedIcons.Class.Id`. The PSI provides the `PsiIconManager` to retrieve icons for a specific declared element.
5+
While the Shell provides the `ThemedIconManager` class in order to load and create icons, it is a low level API. It provides no means for getting the icon for a class, other than explicitly loading `PsiSymbolsThemedIcons.Class.Id`. The PSI provides the `PsiIconManager` to retrieve icons for a specific declared element.
66

77
The `PsiIconManager` provides the following methods and properties:
88

@@ -55,9 +55,3 @@ Furthermore, ReSharper ships with a colour icon provider, which recognises type
5555
The collection can be extended by creating a class that implements `IDeclaredElementIconProvider` and is decorated with the `[DeclaredElementIconProvider]` attribute. This scopes the class to PSI-shared component lifetime (that is, the same lifetime as a `ShellComponent`). Should the class need to have a narrower lifetime, such as `[SolutionComponent]`, it is possible to call `PsiIconManager.AddExtension` in the provider's constructor, passing in it's own `Lifetime` for cleanup. The unit test icon provider does this, as it depends on components that have solution lifetime scope.
5656

5757
The `IDeclaredElementIconExtensionProvider` can be implemented to extend the process for deciding what modifiers should be applied to the icon (private, public, etc.). The class should be decorated with the `[DeclaredElementIconExtensionProvider]` attribute, or can also be registered by calling `PsiIconManager.AddExtension` if the component has different lifetime requirements. This provider is currently implemented for CLR and C++ elements.
58-
59-
## Loading icons manually
60-
61-
It is not recommended to load icons directly, but they are available in the [`ThemedIconManager`](ConsumingIcons.md). Simply use the icon IDs defined in the `PsiSymbolsThemedIcons` class, and use [`CompositeIconId.Compose`](IconTypes.md#composite-icons) method to apply modifiers. There are language specific icons in other classes, such `PsiCssThemedIcons` or `PsiBuildScriptsThemedIcons`.
62-
63-
The `PsiIconManager` provides a more flexible and extensible way of getting the correct icon.

topics/Platform/Shell/Icons/ConsumingIcons.md

Lines changed: 0 additions & 103 deletions
This file was deleted.

0 commit comments

Comments
 (0)