Skip to content

Commit 770b82d

Browse files
authored
Merge pull request WolvenKit#2780 from WolvenKit/manavortex-patch-1
CvmDropdownHelper.cs: better comments
2 parents 25d2ca4 + 5233517 commit 770b82d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

WolvenKit.App/Helpers/CvmDropdownHelper.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ namespace WolvenKit.App.Helpers;
1111

1212
/// <summary>
1313
/// This class takes a <see cref="ChunkViewModel"/> and returns a list of compatible strings for the view.
14+
/// To register a dropdown menu for a view, you have to do the following things:
15+
/// 1. adjust HasDropdownOptions (the switch case matches on cvm's PARENT)
16+
/// 2. adjust GetDropdownOptions (switch case matches on cvm's PARENT)
17+
/// 3. optional: adjust ShouldShowRefreshButton (switch casse matches on cvm's ROOT)
1418
/// </summary>
1519
public abstract class CvmDropdownHelper
1620
{
@@ -995,7 +999,9 @@ IRedArray<CName> when parent.Name is "names" &&
995999
}
9961000

9971001
/// <summary>
998-
/// Show the refresh button (e.g. to load data from a different file)?
1002+
/// Show the refresh button?
1003+
/// If other files need to be parsed to display the options, they aren't loaded on every change,
1004+
/// but instead only refresh on a click of the button
9991005
/// </summary>
10001006
public static bool ShouldShowRefreshButton(ChunkViewModel cvm)
10011007
{

0 commit comments

Comments
 (0)