Interface IMainViewAPI
Describes object providing API for main UI view.
public interface IMainViewAPI
Properties
ActiveDesktopView
Gets currently active Desktop mode view.
DesktopView ActiveDesktopView { get; set; }
Property Value
ActiveFullscreenView
Gets currently active Fullscreen mode view.
FullscreenView ActiveFullscreenView { get; }
Property Value
FilteredGames
Gets list of games currently available in game list.
List<Game> FilteredGames { get; }
Property Value
Grouping
Gets currently active grouping field.
GroupableField Grouping { get; set; }
Property Value
SelectedGames
Gets list of currently selected games.
IEnumerable<Game> SelectedGames { get; }
Property Value
SortOrder
Gets currently active sorting order.
SortOrder SortOrder { get; }
Property Value
SortOrderDirection
Gets currently active sorting order direction.
SortOrderDirection SortOrderDirection { get; set; }
Property Value
UIDispatcher
Gets UI thread dispatcher.
Dispatcher UIDispatcher { get; }
Property Value
Methods
ApplyFilterPreset(FilterPreset)
Applies filter preset.
void ApplyFilterPreset(FilterPreset preset)
Parameters
preset
FilterPresetFilter preset.
ApplyFilterPreset(Guid)
Applies filter preset.
void ApplyFilterPreset(Guid filterId)
Parameters
filterId
GuidFilter ID.
GetActiveFilterPreset()
Gets ID of currently active filter preset.
Guid GetActiveFilterPreset()
Returns
GetCurrentFilterSettings()
Gets current filter settings.
FilterPresetSettings GetCurrentFilterSettings()
Returns
OpenPluginSettings(Guid)
Opens settings view for specified plugin.
bool OpenPluginSettings(Guid pluginId)
Parameters
pluginId
GuidPlugin ID.
Returns
- bool
True if user saved any changes, False if dialog was canceled.
OpenSearch(SearchContext, string)
Opens global search view.
void OpenSearch(SearchContext context, string searchTerm)
Parameters
context
SearchContextSearch context to be activated after opening the view.
searchTerm
stringDefault search term.
OpenSearch(string)
Opens global search view.
void OpenSearch(string searchTerm)
Parameters
searchTerm
stringDefault search term.
SelectGame(Guid)
Selects game.
void SelectGame(Guid gameId)
Parameters
gameId
GuidGame's database ID.
SelectGames(IEnumerable<Guid>)
Selects multiple games.
void SelectGames(IEnumerable<Guid> gameIds)
Parameters
gameIds
IEnumerable<Guid>List of game IDs to select.
SwitchToLibraryView()
Switches Playnite to Library view.
void SwitchToLibraryView()