SettingsView

Remarks

Doc 20's A4 is "two windows, one mechanism", and this is the mechanism. The only difference between Preferences and Project Settings is whose store the pages are over — the user's or the project's — so a second implementation of the rail, the search, the reset and the dirty tracking would be a second place for those four to be subtly wrong.

⚠ A panel rather than a modal, and doc 20's A2 is why. Everything modal in this editor is a drawn Dialog in the shell's own document, so that the golden suite can photograph it and the automation harness can drive it — and a settings window is the one thing people leave open beside what they are changing. Registered as a panel, it docks, it tabs, and view.float-panel gives it a real operating-system window when the user wants one, which is the same answer doc 20's "two windows" asks for by a different route.

⚠ Nothing is written on a keystroke. Doc 20 is explicit: the layout file's rule — written on the way down — applies here for the same reason, with an explicit Apply for anything that costs something to change. So an edit marks the window dirty, Apply is what commits, and Revert rebuilds the page from what is still on disk.

Fields and properties (13)

• protected override string TagName

  The element name this type answers to when a caller does not choose one.

• protected override bool AcceptsFocus

  Whether the focus can rest on this kind of control at all.

• public SearchBox Search

  The search box over every setting on every page.

• public UiElement Rail

  The list of pages down the left.

• public UiElement Pane

  Where the chosen page is built.

• public UiElement Footer

  The strip along the bottom.

• public Button ResetPage

  Puts this page back to its defaults.

• public Button Revert

  Throws away what has been typed since the last write.

• public Button Apply

  Writes it.

• public IReadOnlyList<SettingsCategory> Categories

  The pages, in the order they were added.

• public string? Current

  Which page is showing, or before one has been chosen.

• public string? Query

  What the search box says, or when it is empty.

• public bool IsDirty

  Whether something has been edited and not yet written.

Events (3)

• public Action<SettingsView>? Applied

  Raised when the user asks for the edits to be written.

• public Action<SettingsView>? Reverted

  Raised when they ask for them to be thrown away.

• public Action<SettingsView, UiElement>? PageShown

  Raised with the pane whenever the page or the search text changes.

Methods (4)

• protected override void OnCreated()

  Builds whatever this element is made of, once, as it joins a document.

• public SettingsCategory Add(SettingsCategory category)

  Adds a page.

• public bool Select(string id)

  Shows a page.

• public void Reload()

  Builds the current page again, from whatever the model now says.

Used by (2)

• EditorApplicationVixen.Editor.App
• SettingsWindowTestsVixen.Editor.App.Tests