14660 lines
663 KiB
XML
Executable File
14660 lines
663 KiB
XML
Executable File
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>RSG.Editor</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:RSG.Editor.ButtonActionAsync`2">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a button command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter pass into the can execute and execute methods.
|
|
</typeparam>
|
|
<typeparam name="TSecondary">
|
|
The type of the secondary parameter passed into the can execute and execute methods
|
|
that has been send with the command.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonActionAsync`2.#ctor(RSG.Editor.ICommandServiceProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ButtonActionAsync`2"/>
|
|
class.
|
|
</summary>
|
|
<param name="serviceProvider">
|
|
The service provider that is used by this action to perform application specific
|
|
operations, for example selecting a file to open.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonActionAsync`2.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ButtonActionAsync`2"/>
|
|
class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonActionAsync`2.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ButtonActionAsync`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a button command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter pass into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonActionAsync`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ButtonActionAsync`1"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonActionAsync`1.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ButtonAction`2">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a button command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter pass into the can execute and execute methods.
|
|
</typeparam>
|
|
<typeparam name="TSecondary">
|
|
The type of the secondary parameter passed into the can execute and execute methods
|
|
that has been send with the command.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonAction`2.#ctor(RSG.Editor.ICommandServiceProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ButtonAction`2"/> class.
|
|
</summary>
|
|
<param name="serviceProvider">
|
|
The service provider that is used by this action to perform application specific
|
|
operations, for example selecting a file to open.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonAction`2.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ButtonAction`2"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonAction`2.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ButtonAction`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a button command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter pass into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonAction`1.#ctor(RSG.Editor.ICommandServiceProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ButtonAction`1"/> class.
|
|
</summary>
|
|
<param name="serviceProvider">
|
|
The service provider that is used by this action to perform application specific
|
|
operations, for example selecting a file to open.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonAction`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ButtonAction`1"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonAction`1.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ComboActionAsync`2">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a combo command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
<typeparam name="TItem">
|
|
The type of the combo parameter.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboActionAsync`2.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ComboActionAsync`2"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboActionAsync`2.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboActionAsync`2.GetItems(RSG.Editor.MultiCommand)">
|
|
<summary>
|
|
Override to provide the created definition with the items to show in the combo.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition that the created items will be used for.
|
|
</param>
|
|
<returns>
|
|
The items to show in the combo.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ComboActionAsync`2.Definition">
|
|
<summary>
|
|
The command definition class that is used to create the commands for this
|
|
implementer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ComboActionAsync`2.Definition._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ComboActionAsync`2.Definition.Command"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboActionAsync`2.Definition.#ctor(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ComboActionAsync`2.Definition"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command that this definition is wrapping.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ComboActionAsync`2.Definition.Command">
|
|
<summary>
|
|
Gets the System.Windows.Input.RoutedCommand that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ComboAction`2">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a combo command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
<typeparam name="TItem">
|
|
The type of the combo parameter.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboAction`2.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ComboAction`2"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboAction`2.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboAction`2.GetItems(RSG.Editor.MultiCommand)">
|
|
<summary>
|
|
Override to provide the created definition with the items to show in the combo.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition that the created items will be used for.
|
|
</param>
|
|
<returns>
|
|
The items to show in the combo.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ComboAction`2.Definition">
|
|
<summary>
|
|
The command definition class that is used to create the commands for this
|
|
implementer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ComboAction`2.Definition._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ComboAction`2.Definition.Command"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboAction`2.Definition.#ctor(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ComboAction`2.Definition"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command that this definition is wrapping.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ComboAction`2.Definition.Command">
|
|
<summary>
|
|
Gets the System.Windows.Input.RoutedCommand that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandActionAsync`2">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
<typeparam name="TSecondary">
|
|
The type of the secondary parameter passed into the can execute and execute methods
|
|
that has been send with the command.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandActionAsync`2._resolver">
|
|
<summary>
|
|
The private resolver that this class uses to obtain the command parameter from.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandActionAsync`2._serviceProvider">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandActionAsync`2.ServiceProvider"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.#ctor(RSG.Editor.ICommandServiceProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandActionAsync`2"/>
|
|
class.
|
|
</summary>
|
|
<param name="serviceProvider">
|
|
The service provider that is used by this action to perform application specific
|
|
operations, for example selecting a file to open.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the
|
|
<see cref="T:RSG.Editor.CommandActionAsync`2"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandActionAsync`2.ServiceProvider">
|
|
<summary>
|
|
Sets the service provider that can be used in the Execute methods.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandActionAsync`2.Item(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Gets the command definition that has been created for this implementer for the
|
|
specified routed command.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definition should be returned.
|
|
</param>
|
|
<returns>
|
|
The command definition that has been created for this implementer for the specified
|
|
routed command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Windows.UIElement)">
|
|
<summary>
|
|
Binds this implementation to the specified command and the specified user interface
|
|
element.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="element">
|
|
The element that this implementation will be bound to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Type)">
|
|
<summary>
|
|
Binds this implementation to the specified command for the specified type.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.CanExecute(`0,`1)">
|
|
<summary>
|
|
Override to set logic against the can execute command handler. By default this
|
|
returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="secondaryParameter">
|
|
The secondary command parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.Execute(`0,`1)">
|
|
<summary>
|
|
Override to set logic against the execute command handler.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="secondaryParameter">
|
|
The secondary command parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
A task that represents the work done by the command handler.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.GetService``1">
|
|
<summary>
|
|
Gets the service object of the specified type.
|
|
</summary>
|
|
<typeparam name="TService">
|
|
The type of service object to get.
|
|
</typeparam>
|
|
<returns>
|
|
A service object of the specified type or null if there is no service object of
|
|
that type.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.CanExecute(RSG.Editor.CanExecuteCommandData{`1})">
|
|
<summary>
|
|
Determines whether the associated command can be executed based on the current
|
|
state of the application.
|
|
</summary>
|
|
<param name="data">
|
|
The can execute data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`2.Execute(RSG.Editor.ExecuteCommandData{`1})">
|
|
<summary>
|
|
Called whenever the associated command is fired and needs handling at this instance
|
|
level.
|
|
</summary>
|
|
<param name="data">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandActionAsync`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandActionAsync`1._currentCommand">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandActionAsync`1.CurrentCommand"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandActionAsync`1._resolver">
|
|
<summary>
|
|
The private resolver that this class uses to obtain the command parameter from.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandActionAsync`1._serviceProvider">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandActionAsync`1.ServiceProvider"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandActionAsync`1"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandActionAsync`1.ServiceProvider">
|
|
<summary>
|
|
Sets the service provider that can be used in the Execute methods.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandActionAsync`1.CurrentCommand">
|
|
<summary>
|
|
Gets the current command that is being worked on.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandActionAsync`1.CurrentDefinition">
|
|
<summary>
|
|
Gets the command definition for the currently executing routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandActionAsync`1.Resolver">
|
|
<summary>
|
|
Gets the resolver that was passed into this implementer on initialisation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandActionAsync`1.Item(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Gets the command definition that has been created for this implementer for the
|
|
specified routed command.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definition should be returned.
|
|
</param>
|
|
<returns>
|
|
The command definition that has been created for this implementer for the specified
|
|
routed command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Windows.UIElement)">
|
|
<summary>
|
|
Binds this implementation to the specified command and the specified user interface
|
|
element.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="element">
|
|
The element that this implementation will be bound to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Type)">
|
|
<summary>
|
|
Binds this implementation to the specified command for the specified type.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.CanExecute(`0)">
|
|
<summary>
|
|
Override to set logic against the can execute command handler. By default this
|
|
returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.Execute(`0)">
|
|
<summary>
|
|
Override to set logic against the execute command handler.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<returns>
|
|
A task that represents the work done by the command handler.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.GetService``1">
|
|
<summary>
|
|
Gets the service object of the specified type.
|
|
</summary>
|
|
<typeparam name="TService">
|
|
The type of service object to get.
|
|
</typeparam>
|
|
<returns>
|
|
A service object of the specified type or null if there is no service object of
|
|
that type.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.CanExecute(RSG.Editor.CanExecuteCommandData)">
|
|
<summary>
|
|
Determines whether the associated command can be executed based on the current
|
|
state of the application.
|
|
</summary>
|
|
<param name="data">
|
|
The can execute data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandActionAsync`1.Execute(RSG.Editor.ExecuteCommandData)">
|
|
<summary>
|
|
Called whenever the associated command is fired and needs handling at this instance
|
|
level.
|
|
</summary>
|
|
<param name="data">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandAction`2">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
<typeparam name="TSecondary">
|
|
The type of the secondary parameter passed into the can execute and execute methods
|
|
that has been send with the command.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandAction`2._resolver">
|
|
<summary>
|
|
The private resolver that this class uses to obtain the command parameter from.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandAction`2._serviceProvider">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandAction`2.ServiceProvider"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.#ctor(RSG.Editor.ICommandServiceProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandAction`2"/> class.
|
|
</summary>
|
|
<param name="serviceProvider">
|
|
The service provider that is used by this action to perform application specific
|
|
operations, for example selecting a file to open.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandAction`2"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandAction`2.ServiceProvider">
|
|
<summary>
|
|
Sets the service provider that can be used in the Execute methods.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandAction`2.Item(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Gets the command definition that has been created for this implementer for the
|
|
specified routed command.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definition should be returned.
|
|
</param>
|
|
<returns>
|
|
The command definition that has been created for this implementer for the specified
|
|
routed command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Windows.UIElement)">
|
|
<summary>
|
|
Binds this implementation to the specified command and the specified user interface
|
|
element.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="element">
|
|
The element that this implementation will be bound to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Type)">
|
|
<summary>
|
|
Binds this implementation to the specified command for the specified type.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.CanExecute(`0,`1)">
|
|
<summary>
|
|
Override to set logic against the can execute command handler. By default this
|
|
returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="secondaryParameter">
|
|
The secondary command parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.Execute(`0,`1)">
|
|
<summary>
|
|
Override to set logic against the execute command handler.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="secondaryParameter">
|
|
The secondary command parameter that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.GetService``1">
|
|
<summary>
|
|
Gets the service object of the specified type.
|
|
</summary>
|
|
<typeparam name="TService">
|
|
The type of service object to get.
|
|
</typeparam>
|
|
<returns>
|
|
A service object of the specified type or null if there is no service object of
|
|
that type.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.CanExecute(RSG.Editor.CanExecuteCommandData{`1})">
|
|
<summary>
|
|
Determines whether the associated command can be executed based on the current
|
|
state of the application.
|
|
</summary>
|
|
<param name="data">
|
|
The can execute data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`2.Execute(RSG.Editor.ExecuteCommandData{`1})">
|
|
<summary>
|
|
Called whenever the associated command is fired and needs handling at this instance
|
|
level.
|
|
</summary>
|
|
<param name="data">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandAction`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandAction`1._currentCommand">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandAction`1.CurrentCommand"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandAction`1._resolver">
|
|
<summary>
|
|
The private resolver that this class uses to obtain the command parameter from.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandAction`1._serviceProvider">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandAction`1.ServiceProvider"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.#ctor(RSG.Editor.ICommandServiceProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandAction`1"/> class.
|
|
</summary>
|
|
<param name="serviceProvider">
|
|
The service provider that is used by this action to perform application specific
|
|
operations, for example selecting a file to open.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandAction`1"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandAction`1.ServiceProvider">
|
|
<summary>
|
|
Gets or sets the service provider that can be used in the Execute methods.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandAction`1.CurrentCommand">
|
|
<summary>
|
|
Gets the current command that is being worked on.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandAction`1.CurrentDefinition">
|
|
<summary>
|
|
Gets the command definition for the currently executing routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandAction`1.Resolver">
|
|
<summary>
|
|
Gets the resolver that was passed into this implementer on initialisation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandAction`1.Item(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Gets the command definition that has been created for this implementer for the
|
|
specified routed command.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definition should be returned.
|
|
</param>
|
|
<returns>
|
|
The command definition that has been created for this implementer for the specified
|
|
routed command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Windows.UIElement)">
|
|
<summary>
|
|
Binds this implementation to the specified command and the specified user interface
|
|
element.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="element">
|
|
The element that this implementation will be bound to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Type)">
|
|
<summary>
|
|
Binds this implementation to the specified command for the specified type.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.CanExecute(`0)">
|
|
<summary>
|
|
Override to set logic against the can execute command handler. By default this
|
|
returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.Execute(`0)">
|
|
<summary>
|
|
Override to set logic against the execute command handler.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.GetService``1">
|
|
<summary>
|
|
Gets the service object of the specified type.
|
|
</summary>
|
|
<typeparam name="TService">
|
|
The type of service object to get.
|
|
</typeparam>
|
|
<returns>
|
|
A service object of the specified type or null if there is no service object of
|
|
that type.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.CanExecute(RSG.Editor.CanExecuteCommandData)">
|
|
<summary>
|
|
Determines whether the associated command can be executed based on the current
|
|
state of the application.
|
|
</summary>
|
|
<param name="data">
|
|
The can execute data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandAction`1.Execute(RSG.Editor.ExecuteCommandData)">
|
|
<summary>
|
|
Called whenever the associated command is fired and needs handling at this instance
|
|
level.
|
|
</summary>
|
|
<param name="data">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandData">
|
|
<summary>
|
|
Provides the base class for data that is sent to the execute or can execute command
|
|
delegates.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandData._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandData.Command"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandData._originalSource">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandData.OriginalSource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandData._sender">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandData.Sender"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandData._source">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandData.Source"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandData.#ctor(System.Windows.Input.ICommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandData"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command associated with this data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandData.Command">
|
|
<summary>
|
|
Gets the command associated with this data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandData.OriginalSource">
|
|
<summary>
|
|
Gets the original reporting source as determined by pure hit testing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandData.Sender">
|
|
<summary>
|
|
Gets or sets the System.Windows.UIElement where the event handler is attached.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandData.Source">
|
|
<summary>
|
|
Gets a reference to the object that raised the routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandInstanceCreationArgs">
|
|
<summary>
|
|
Encapsulates the arguments used to create a new command instance using the
|
|
<see cref="T:RSG.Editor.RockstarCommandManager"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandInstanceCreationArgs._displayStyle">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandInstanceCreationArgs.DisplayStyle"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandInstanceCreationArgs._areMultiItemsShown">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandInstanceCreationArgs.AreMultiItemsShown"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandInstanceCreationArgs._eachItemStartsGroup">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandInstanceCreationArgs.EachItemStartsGroup"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandInstanceCreationArgs._showFilterCount">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandInstanceCreationArgs.ShowFilterCount"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandInstanceCreationArgs._width">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandInstanceCreationArgs.Width"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandInstanceCreationArgs.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandInstanceCreationArgs"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandInstanceCreationArgs.AreMultiItemsShown">
|
|
<summary>
|
|
Gets or sets a value indicating whether the created command instance shows its
|
|
child items as individual items in the user interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandInstanceCreationArgs.EachItemStartsGroup">
|
|
<summary>
|
|
Gets or sets a value indicating whether the created command instance individual
|
|
items start a group each or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandInstanceCreationArgs.ShowFilterCount">
|
|
<summary>
|
|
Gets or sets a value indicating whether the created command instance shows its
|
|
filter count in the user interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandInstanceCreationArgs.DisplayStyle">
|
|
<summary>
|
|
Gets or sets a value that determines what the display style is for the created
|
|
command instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandInstanceCreationArgs.Width">
|
|
<summary>
|
|
Gets or sets the width of the control used for the created command instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.DispatcherHelper">
|
|
<summary>
|
|
A helper class for dispatcher operations on the UI thread. This class can be used
|
|
inside a view model assembly to push actions onto the main UI thread without the need
|
|
to constantly check the current application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DispatcherHelper._uiDispatcher">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.DispatcherHelper.UIDispatcher"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.DispatcherHelper.UIDispatcher">
|
|
<summary>
|
|
Gets a reference to the UI threads dispatcher object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DispatcherHelper.BeginInvokeOnUI(System.Action,System.Windows.Threading.DispatcherPriority)">
|
|
<summary>
|
|
Executes an action on the UI thread. If this method is called from the UI thread,
|
|
the action is executed immediately. If the method is called from another thread,
|
|
the action will be enqueued on the UI thread's dispatcher and executed
|
|
asynchronously.
|
|
</summary>
|
|
<param name="action">
|
|
The action that will be executed on the UI thread.
|
|
</param>
|
|
<param name="priority">
|
|
The priority, relative to the other pending operations in the event queue, the
|
|
specified method is invoked.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.DispatcherHelper.CheckBeginInvokeOnUI(System.Action)">
|
|
<summary>
|
|
Executes an action on the UI thread. If this method is called from the UI thread,
|
|
the action is executed immediately. If the method is called from another thread,
|
|
the action will be enqueued on the UI thread's dispatcher and executed
|
|
asynchronously.
|
|
</summary>
|
|
<param name="action">
|
|
The action that will be executed on the UI thread.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.DispatcherHelper.Initialize">
|
|
<summary>
|
|
This method should be called once on the UI thread to ensure that the
|
|
<see cref="P:RSG.Editor.DispatcherHelper.UIDispatcher"/> property is initialised. Call this method on the static
|
|
App() constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DispatcherHelper.InvokeOnUI(System.Action)">
|
|
<summary>
|
|
Executes an action on the UI thread.
|
|
</summary>
|
|
<param name="action">
|
|
The action that will be executed on the UI thread.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.DispatcherHelper.InvokeOnUI(System.Action,System.Windows.Threading.DispatcherPriority)">
|
|
<summary>
|
|
Executes an action on the UI thread.
|
|
</summary>
|
|
<param name="action">
|
|
The action that will be executed on the UI thread.
|
|
</param>
|
|
<param name="priority">
|
|
The priority, relative to the other pending operations in the event queue, the
|
|
specified method is invoked.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.DispatcherHelper.RunAsync(System.Action)">
|
|
<summary>
|
|
Invokes an action asynchronously on the UI thread.
|
|
</summary>
|
|
<param name="action">
|
|
The action that is executed.
|
|
</param>
|
|
<returns>
|
|
An object that can be used to interact with the delegate as it is pending execution
|
|
in the event queue.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.DispatcherHelper.CheckDispatcher">
|
|
<summary>
|
|
Checks to make sure the <see cref="M:RSG.Editor.DispatcherHelper.Initialize"/> method has been called.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.DynamicMenuCommand">
|
|
<summary>
|
|
Represents a command definition that contains a dynamic list of instances inside of it
|
|
bound to the same routed command with different parameters. This command definition
|
|
when no items are specified shows the menu item as a command item with no command
|
|
parameter. This can be thought of as a menu controller with just one routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DynamicMenuCommand._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.DynamicMenuCommand.Command"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DynamicMenuCommand._items">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.DynamicMenuCommand.Items"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DynamicMenuCommand.#ctor(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.DynamicMenuCommand"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The routed command that is being wrapped by this definition.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.DynamicMenuCommand.Command">
|
|
<summary>
|
|
Gets the System.Windows.Input.RoutedCommand that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.DynamicMenuCommand.Items">
|
|
<summary>
|
|
Gets a collection of items that represent the different items that can be executed
|
|
through this command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.DynamicValueSolver`1">
|
|
<summary>
|
|
Represents a value solver that can forward changes from one source to an additional
|
|
listener.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the target value.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.DynamicValueSolver`1._currentValue">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.DynamicValueSolver`1.CurrentValue"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DynamicValueSolver`1._fallbackValue">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.DynamicValueSolver`1.FallbackValue"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DynamicValueSolver`1._stringFormat">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.DynamicValueSolver`1.StringFormat"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DynamicValueSolver`1.#ctor(System.ComponentModel.INotifyPropertyChanged,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.DynamicValueSolver`1"/> class.
|
|
</summary>
|
|
<param name="source">
|
|
The source object that original raises the property changed event.
|
|
</param>
|
|
<param name="propertyName">
|
|
The name of the property on the source object that should be listened to.
|
|
</param>
|
|
</member>
|
|
<member name="E:RSG.Editor.DynamicValueSolver`1.ValueChanged">
|
|
<summary>
|
|
Occurs when the value this class is handling changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.DynamicValueSolver`1.CurrentValue">
|
|
<summary>
|
|
Gets the currently solved value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.DynamicValueSolver`1.FallbackValue">
|
|
<summary>
|
|
Gets or sets the fall back value to use if the current value is null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.DynamicValueSolver`1.StringFormat">
|
|
<summary>
|
|
Gets or sets the format string used to convert the data to type String.
|
|
</summary>
|
|
<remarks>
|
|
This property is object used when the target type is a String.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:RSG.Editor.DynamicValueSolver`1.OnPropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Occurs when the listened to property has changed.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs containing the event data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.DynamicValueSolver`1.UpdateCurrentValue(System.Object,System.String)">
|
|
<summary>
|
|
Updates the currently value by reflecting into the specified source object and
|
|
looking for the value of the property with the specified name.
|
|
</summary>
|
|
<param name="source">
|
|
The source for the value.
|
|
</param>
|
|
<param name="propertyName">
|
|
The name of the property the value should be retrieved from.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.FileBackupManager">
|
|
<summary>
|
|
Provides a central class used to backup and recover changes to a document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileBackupManager._backupDirectory">
|
|
<summary>
|
|
The full path to the directory that contains the backup files.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileBackupManager._interval">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.FileBackupManager.Interval"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileBackupManager._registeredItems">
|
|
<summary>
|
|
The weak reference collection of registered items.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileBackupManager._syncObject">
|
|
<summary>
|
|
The generic sync object to support multithreading.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileBackupManager._timer">
|
|
<summary>
|
|
The timer object used to time the interval between backups.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileBackupManager.#ctor(System.TimeSpan,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FileBackupManager"/> class.
|
|
</summary>
|
|
<param name="interval">
|
|
The time interval between backup saves.
|
|
</param>
|
|
<param name="backupDirectory">
|
|
The root directory the backup saves should be kept.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.FileBackupManager.BackupDirectory">
|
|
<summary>
|
|
Gets or sets the backup directory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.FileBackupManager.Interval">
|
|
<summary>
|
|
Gets or sets the time span between the backup saves.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileBackupManager.RegisterFile(RSG.Editor.ISaveableDocument)">
|
|
<summary>
|
|
Registers the specified item to be backed up.
|
|
</summary>
|
|
<param name="saveableItem">
|
|
The item to register.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileBackupManager.UnregisterFile(RSG.Editor.ISaveableDocument)">
|
|
<summary>
|
|
Unregisters the specified item.
|
|
</summary>
|
|
<param name="saveableItem">
|
|
The item to unregister.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileBackupManager.DisposeManagedResources">
|
|
<summary>
|
|
When overridden disposes of the managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileBackupManager.StartBackup(System.Object,System.Timers.ElapsedEventArgs)">
|
|
<summary>
|
|
Starts the backup logic by kicking off a background thread to go through and save
|
|
all modified registered items.
|
|
</summary>
|
|
<param name="sender">
|
|
The System.Timers.ElapsedEventArgs containing the event data.
|
|
</param>
|
|
<param name="e">
|
|
The timer this handler is attached to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileBackupManager.OnRegisteredItemSaved(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Called whenever a item that has been registered is saved successfully. When this
|
|
occurs we no longer need the backup file and can delete it.
|
|
</summary>
|
|
<param name="sender">
|
|
The registered file that was saved.
|
|
</param>
|
|
<param name="e">
|
|
Always EventArgs.Empty.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.FileWatcherManager">
|
|
<summary>
|
|
Provides a central class to listen to external changes made to a file on the disk and
|
|
the read-only attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileWatcherManager._cache">
|
|
<summary>
|
|
The private collection of current file system watchers running.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileWatcherManager._currentValues">
|
|
<summary>
|
|
The private dictionary containing the current values for a watched file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileWatcherManager._suspendedChangePaths">
|
|
<summary>
|
|
The private set of full paths whose change event have been suspended.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FileWatcherManager"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.FileWatcherManager.ModifiedTimeChanged">
|
|
<summary>
|
|
Occurs whenever a watched file has its last write time changed.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.FileWatcherManager.ReadOnlyFlagChanged">
|
|
<summary>
|
|
Occurs whenever a watched file has its read-only flag changed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.RegisterFile(System.String)">
|
|
<summary>
|
|
Registers the specified path to be watched for changes.
|
|
</summary>
|
|
<param name="fullPath">
|
|
The path to the file that needs watching.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.SuspendChangeEvent(System.String)">
|
|
<summary>
|
|
Suspend the change event for the specified full path. This method returns a
|
|
disposable scope object that when disposed of will remove the suspension.
|
|
</summary>
|
|
<param name="fullPath">
|
|
The full path to the file whose change event will be suspended.
|
|
</param>
|
|
<returns>
|
|
A disposable scope object that when disposed of will remove the suspension.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.UnregisterFile(System.String)">
|
|
<summary>
|
|
Unregisters the specified file as a watched item.
|
|
</summary>
|
|
<param name="fullPath">
|
|
The path to the file that doesn't need watching anymore.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.OnWatcherChanged(System.Object,System.IO.FileSystemEventArgs)">
|
|
<summary>
|
|
Called whenever a attribute is changed on a watched file or the last write time is
|
|
modified.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.IO.FileSystemEventArgs containing the event data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.FileWatcherManager.CurrentValues">
|
|
<summary>
|
|
Contains the previous read-only value and previous write time for a file so that
|
|
it can be checked whether these values have changed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileWatcherManager.CurrentValues._isReadOnly">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.FileWatcherManager.CurrentValues.IsReadOnly"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileWatcherManager.CurrentValues._lastWriteTimeUtc">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.FileWatcherManager.CurrentValues.LastWriteTimeUtc"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.CurrentValues.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FileWatcherManager.CurrentValues"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.FileWatcherManager.CurrentValues.IsReadOnly">
|
|
<summary>
|
|
Gets or sets a value indicating whether the associated file is read-only or
|
|
not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.FileWatcherManager.CurrentValues.LastWriteTimeUtc">
|
|
<summary>
|
|
Gets or sets the last write time for the associated file.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.FileWatcherManager.Key">
|
|
<summary>
|
|
The class that is used to index the file watcher cache.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.Key.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FileWatcherManager.Key"/> class.
|
|
</summary>
|
|
<param name="directory">
|
|
The directory to monitor.
|
|
</param>
|
|
<param name="filter">
|
|
The type of files to watch.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.FileWatcherManager.SuspendChangeEventScope">
|
|
<summary>
|
|
Provides functionality so that the file watchers change event can be suspended
|
|
for a specific file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileWatcherManager.SuspendChangeEventScope._fullPath">
|
|
<summary>
|
|
The full path to the file whose change event should be suspended.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FileWatcherManager.SuspendChangeEventScope._manager">
|
|
<summary>
|
|
The private reference of the file watcher manager that this is suspending.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.SuspendChangeEventScope.#ctor(System.String,RSG.Editor.FileWatcherManager)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FileWatcherManager.SuspendChangeEventScope"/> class.
|
|
</summary>
|
|
<param name="fullPath">
|
|
The full path to the file that change event should be suspended.
|
|
</param>
|
|
<param name="manager">
|
|
The file watcher manager that is being suspended.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.FileWatcherManager.SuspendChangeEventScope.DisposeManagedResources">
|
|
<summary>
|
|
Finishes the suspended state that this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.FilterActionAsync`2">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a filter command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
<typeparam name="TFilter">
|
|
The type of the filter parameter.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterActionAsync`2.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FilterActionAsync`2"/>
|
|
class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterActionAsync`2.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterActionAsync`2.GetItems(RSG.Editor.MultiCommand)">
|
|
<summary>
|
|
Override to provide the created definition with the items to show in the filter.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition that the created items will be used for.
|
|
</param>
|
|
<returns>
|
|
The items to show in the filter.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.FilterActionAsync`2.Definition">
|
|
<summary>
|
|
The command definition class that is used to create the commands for this
|
|
implementer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FilterActionAsync`2.Definition._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.FilterActionAsync`2.Definition.Command"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterActionAsync`2.Definition.#ctor(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FilterActionAsync`2.Definition"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command that this definition is wrapping.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.FilterActionAsync`2.Definition.Command">
|
|
<summary>
|
|
Gets the System.Windows.Input.RoutedCommand that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.FilterAction`2">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a filter command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
<typeparam name="TFilter">
|
|
The type of the filter parameter.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterAction`2.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FilterAction`2"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterAction`2.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterAction`2.GetItems(RSG.Editor.MultiCommand)">
|
|
<summary>
|
|
Override to provide the created definition with the items to show in the filter.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition that the created items will be used for.
|
|
</param>
|
|
<returns>
|
|
The items to show in the filter.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.FilterAction`2.Definition">
|
|
<summary>
|
|
The command definition class that is used to create the commands for this
|
|
implementer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.FilterAction`2.Definition._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.FilterAction`2.Definition.Command"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterAction`2.Definition.#ctor(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FilterAction`2.Definition"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command that this definition is wrapping.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.FilterAction`2.Definition.Command">
|
|
<summary>
|
|
Gets the System.Windows.Input.RoutedCommand that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.IApplicationInfoProvider">
|
|
<summary>
|
|
Interface from which application information can be obtained.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IApplicationInfoProvider.AuthorEmailAddress">
|
|
<summary>
|
|
Gets a semi-colon separate list of the application authors email addresses. These
|
|
are the addresses which are used to determine where any mails generated by the
|
|
application should be sent to by default.
|
|
e.g.
|
|
*tools@rockstarnorth.com
|
|
michael.taschler@rockstarnorth.com;dave.evans@rockstarnorth.com.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IApplicationInfoProvider.CommandOptions">
|
|
<summary>
|
|
Gets the command line options that are passed into this instance of the
|
|
application on start-up.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IApplicationInfoProvider.Version">
|
|
<summary>
|
|
Gets the application version.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.IAsyncCommand">
|
|
<summary>
|
|
When implemented represents a asynchronous version of a command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.IAsyncCommand.CanExecute(System.Object)">
|
|
<summary>
|
|
Gets called when the manager is deciding if this command can be executed. This
|
|
returns true be default.
|
|
</summary>
|
|
<param name="parameter">
|
|
The parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IAsyncCommand.ExecuteAsync(System.Object)">
|
|
<summary>
|
|
Asynchronously executes the command.
|
|
</summary>
|
|
<param name="parameter">
|
|
The parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
A task that is executing the command logic.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.IBugstarInfoProvider">
|
|
<summary>
|
|
Interface from which bugstar information can be obtained.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IBugstarInfoProvider.BugstarComponent">
|
|
<summary>
|
|
Gets the name of the bugstar component that bugs should have their component
|
|
set to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IBugstarInfoProvider.BugstarProjectName">
|
|
<summary>
|
|
Gets the name of the bugstar project that bugs should be added to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IBugstarInfoProvider.DefaultBugOwner">
|
|
<summary>
|
|
Gets the name of the default owner to assign bugs to.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ICommandAction">
|
|
<summary>
|
|
When implemented represents a command implementer class that elements or types can bind
|
|
to.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommandAction.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Windows.UIElement)">
|
|
<summary>
|
|
Binds this implementation to the specified command and the specified user interface
|
|
element.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="element">
|
|
The element that this implementation will be bound to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommandAction.AddBinding(RSG.Editor.RockstarRoutedCommand,System.Type)">
|
|
<summary>
|
|
Binds this implementation to the specified command for the specified type.
|
|
</summary>
|
|
<param name="command">
|
|
The command to bind to this implementation.
|
|
</param>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.ICommandWithIcon">
|
|
<summary>
|
|
When implemented represents a command definition class that contains a command
|
|
parameter property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ICommandWithIcon.Icon">
|
|
<summary>
|
|
Gets the System.Windows.Media.Imaging.BitmapSource object that represents the icon
|
|
that is used for this command, this can be null.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ICommonDialogService">
|
|
<summary>
|
|
When implemented represents a service that can be used to handle a request to show the
|
|
user one of the common dialog windows.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.HandleSavingOfReadOnlyFile(System.String@,System.Boolean@)">
|
|
<summary>
|
|
Handles the situation of trying to save to a read-only file.
|
|
</summary>
|
|
<param name="fullPath">
|
|
The full path to the file being saved.
|
|
</param>
|
|
<param name="cancelled">
|
|
A value that is set to true if during the handling the user chooses to cancel
|
|
the operation.
|
|
</param>
|
|
<returns>
|
|
True if the specified full path is need writable; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.ShowOpenFile(System.String,System.String,System.String,System.Int32,System.String@)">
|
|
<summary>
|
|
Shows the open file dialog window to the user so that they can select a single file
|
|
to read from.
|
|
</summary>
|
|
<param name="directory">
|
|
The initial directory that is displayed by the file dialog.
|
|
</param>
|
|
<param name="filename">
|
|
A string containing the initial full path of the file selected in the file
|
|
dialog.
|
|
</param>
|
|
<param name="filter">
|
|
The filter that determines what types of files are displayed in the file
|
|
dialog.
|
|
</param>
|
|
<param name="filterIndex">
|
|
The index of the filter currently selected in the file dialog.
|
|
</param>
|
|
<param name="location">
|
|
When this method returns contains the full path to the file the user selected
|
|
if valid.
|
|
</param>
|
|
<returns>
|
|
True if the user clicks the OK button; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.ShowOpenFile(System.String,System.String,System.String,System.Int32,System.String[]@)">
|
|
<summary>
|
|
Shows the open file dialog window to the user so that they can select a single file
|
|
to read from.
|
|
</summary>
|
|
<param name="directory">
|
|
The initial directory that is displayed by the file dialog.
|
|
</param>
|
|
<param name="filename">
|
|
A string containing the initial full path of the file selected in the file
|
|
dialog.
|
|
</param>
|
|
<param name="filter">
|
|
The filter that determines what types of files are displayed in the file
|
|
dialog.
|
|
</param>
|
|
<param name="filterIndex">
|
|
The index of the filter currently selected in the file dialog.
|
|
</param>
|
|
<param name="filepaths">
|
|
When this method returns contains the full path to the files the user selected
|
|
if valid.
|
|
</param>
|
|
<returns>
|
|
True if the user clicks the OK button; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.ShowSaveFile(System.String,System.String,System.String@)">
|
|
<summary>
|
|
Shows the save file dialog window to the user so that they can select a single file
|
|
to write to.
|
|
</summary>
|
|
<param name="directory">
|
|
The initial directory that is displayed by the file dialog.
|
|
</param>
|
|
<param name="filename">
|
|
A string containing the initial full path of the file selected in the file dialog.
|
|
</param>
|
|
<param name="destination">
|
|
When this method returns contains the full path to the file the user selected if
|
|
valid.
|
|
</param>
|
|
<returns>
|
|
True if the user clicks the OK button; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.ShowSaveFile(System.String,System.String,System.String,System.Int32,System.String@)">
|
|
<summary>
|
|
Shows the save file dialog window to the user so that they can select a single file
|
|
to write to.
|
|
</summary>
|
|
<param name="directory">
|
|
The initial directory that is displayed by the file dialog.
|
|
</param>
|
|
<param name="filename">
|
|
A string containing the initial full path of the file selected in the file dialog.
|
|
</param>
|
|
<param name="filter">
|
|
The filter that determines what types of files are displayed in the file.
|
|
</param>
|
|
<param name="filterIndex">
|
|
The index of the filter currently selected in the file dialog.
|
|
</param>
|
|
<param name="destination">
|
|
When this method returns contains the full path to the file the user selected if
|
|
valid.
|
|
</param>
|
|
<returns>
|
|
True if the user clicks the OK button; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.ShowSelectFolder(System.Guid,System.String,System.String@)">
|
|
<summary>
|
|
Shows the selected folder dialog to the user so that they can select a folder
|
|
and returns the result back in the <paramref name="directory"/> parameter.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier to use to control the persistence of this dialog.
|
|
</param>
|
|
<param name="title">
|
|
The title to show on the window.
|
|
</param>
|
|
<param name="directory">
|
|
When this method returns contains the full path to the directory the user
|
|
selected if valid.
|
|
</param>
|
|
<returns>
|
|
True if the user selected a folder; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.ShowSelectFolder(System.Guid,System.String,System.String,System.String@)">
|
|
<summary>
|
|
Shows the selected folder dialog to the user so that they can select a folder
|
|
and returns the result back in the <paramref name="directory"/> parameter.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier to use to control the persistence of this dialog.
|
|
</param>
|
|
<param name="initialDirectory">
|
|
The initial directory that is displayed by the folder dialog.
|
|
</param>
|
|
<param name="title">
|
|
The title to show on the window.
|
|
</param>
|
|
<param name="directory">
|
|
When this method returns contains the full path to the directory the user
|
|
selected if valid.
|
|
</param>
|
|
<returns>
|
|
True if the user selected a folder; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.ShowMultiSelectFolder(System.Guid,System.String,System.String[]@)">
|
|
<summary>
|
|
Shows the selected folder dialog to the user so that they can select folders
|
|
and returns the result back in the <paramref name="directories"/> parameter.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier to use to control the persistence of this dialog.
|
|
</param>
|
|
<param name="title">
|
|
The title to show on the window.
|
|
</param>
|
|
<param name="directories">
|
|
When this method returns contains an array of full paths to the directories the user
|
|
selected if valid.
|
|
</param>
|
|
<returns>
|
|
True if the user selected a folder; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommonDialogService.ShowMultiSelectFolder(System.Guid,System.String,System.String,System.String[]@)">
|
|
<summary>
|
|
Shows the selected folder dialog to the user so that they can select folders
|
|
and returns the result back in the <paramref name="directories"/> parameter.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier to use to control the persistence of this dialog.
|
|
</param>
|
|
<param name="initialDirectory">
|
|
The initial directory that is displayed by the folder dialog.
|
|
</param>
|
|
<param name="title">
|
|
The title to show on the window.
|
|
</param>
|
|
<param name="directories">
|
|
When this method returns contains an array of full paths to the directories the user
|
|
selected if valid.
|
|
</param>
|
|
<returns>
|
|
True if the user selected a folder; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.IDynamicMenuItem">
|
|
<summary>
|
|
Provides a base class to objects representing a item for a
|
|
<see cref="T:RSG.Editor.DynamicMenuCommand"/> definition object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IDynamicMenuItem.CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IDynamicMenuItem.ParentDefinition">
|
|
<summary>
|
|
Gets the parent command definition that this is an item for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IDynamicMenuItem.Text">
|
|
<summary>
|
|
Gets or sets the text that is used to display this item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.IMessageBox">
|
|
<summary>
|
|
When implemented represents a message box that can be modified and shown to the user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMessageBox.Caption">
|
|
<summary>
|
|
Gets or sets the string that specifies the title bar caption to display.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMessageBox.HelpUrl">
|
|
<summary>
|
|
Gets or sets the url string that is shown when the user chooses to view help. The
|
|
help button is only shown if this is set to non empty/null string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMessageBox.ImageSource">
|
|
<summary>
|
|
Gets or sets the image source of the 32x32 icon that should be displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMessageBox.Text">
|
|
<summary>
|
|
Gets or sets the string that specifies the text to display.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBox.AddButton(System.String,System.Int64,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Adds a button to the message box for the user to interact with with the specified
|
|
content as the text and the specified value as the value that is returned to the
|
|
client if the user selects this value.
|
|
</summary>
|
|
<param name="content">
|
|
The text that should appear on the button.
|
|
</param>
|
|
<param name="value">
|
|
The value that is set as the selected value if the user closes the window by
|
|
pressing this button.
|
|
</param>
|
|
<param name="isDefault">
|
|
A value indicating whether this is the default button for the user to press.
|
|
</param>
|
|
<param name="isCancel">
|
|
A value indicating whether this is the cancel button for the window and the button
|
|
that will be executed when the user presses escape.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBox.SetIconToExclamation">
|
|
<summary>
|
|
Sets the icon image to the systems exclamation icon.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBox.SetSystemIcon(System.Windows.MessageBoxImage)">
|
|
<summary>
|
|
Sets a system message box icon.
|
|
</summary>
|
|
<param name="icon">
|
|
A value indicating the system message box icon to show.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBox.ShowMessageBox">
|
|
<summary>
|
|
Displays this message box as it has been setup and returns a result.
|
|
</summary>
|
|
<returns>
|
|
A long value that specifies which message box button is clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBox.ShowMessageBox(System.Windows.Window)">
|
|
<summary>
|
|
Displays this message box as it has been setup and returns a result.
|
|
</summary>
|
|
<param name="owner">
|
|
A System.Windows.Window that represents the owner window of the message box.
|
|
</param>
|
|
<returns>
|
|
A long value that specifies which message box button is clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.IMessageBoxService">
|
|
<summary>
|
|
When implemented represents a service that can be used to handle a request to show a
|
|
message box to the user.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.CreateMessageBox">
|
|
<summary>
|
|
Creates a new message box that can be modified and shown to the user.
|
|
</summary>
|
|
<returns>
|
|
A newly created message box object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.String)">
|
|
<summary>
|
|
Displays a message box that has a message and that returns a result.
|
|
</summary>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.Windows.Window,System.String)">
|
|
<summary>
|
|
Displays a message box in front of the specified window that has a message and that
|
|
returns a result.
|
|
</summary>
|
|
<param name="owner">
|
|
A System.Windows.Window that represents the owner window of the message box.
|
|
</param>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.String,System.String)">
|
|
<summary>
|
|
Displays a message box that has a message and title bar caption; and that returns a
|
|
result.
|
|
</summary>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.Windows.Window,System.String,System.String)">
|
|
<summary>
|
|
Displays a message box in front of the specified window that has a message and
|
|
title bar caption; and that returns a result.
|
|
</summary>
|
|
<param name="owner">
|
|
A System.Windows.Window that represents the owner window of the message box.
|
|
</param>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.String,System.String,System.Windows.MessageBoxButton)">
|
|
<summary>
|
|
Displays a message box that has a message, title bar caption, and button; and that
|
|
returns a result.
|
|
</summary>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
<param name="button">
|
|
A System.Windows.MessageBoxButton value that specifies which button or buttons to
|
|
display.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.Windows.Window,System.String,System.String,System.Windows.MessageBoxButton)">
|
|
<summary>
|
|
Displays a message box in front of the specified window that has a message, title
|
|
bar caption, and button; and that returns a result.
|
|
</summary>
|
|
<param name="owner">
|
|
A System.Windows.Window that represents the owner window of the message box.
|
|
</param>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
<param name="button">
|
|
A System.Windows.MessageBoxButton value that specifies which button or buttons to
|
|
display.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.String,System.String,System.Windows.MessageBoxButton,System.Windows.MessageBoxImage)">
|
|
<summary>
|
|
Displays a message box that has a message, title bar caption, button, and icon; and
|
|
that returns a result.
|
|
</summary>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
<param name="button">
|
|
A System.Windows.MessageBoxButton value that specifies which button or buttons to
|
|
display.
|
|
</param>
|
|
<param name="icon">
|
|
A System.Windows.MessageBoxImage value that specifies the icon to display.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.Windows.Window,System.String,System.String,System.Windows.MessageBoxButton,System.Windows.MessageBoxImage)">
|
|
<summary>
|
|
Displays a message box in front of the specified window that has a message, title
|
|
bar caption, button, and icon; and that returns a result.
|
|
</summary>
|
|
<param name="owner">
|
|
A System.Windows.Window that represents the owner window of the message box.
|
|
</param>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
<param name="button">
|
|
A System.Windows.MessageBoxButton value that specifies which button or buttons to
|
|
display.
|
|
</param>
|
|
<param name="icon">
|
|
A System.Windows.MessageBoxImage value that specifies the icon to display.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.String,System.String,System.Windows.MessageBoxButton,System.Windows.MessageBoxImage,System.Windows.MessageBoxResult)">
|
|
<summary>
|
|
Displays a message box that has a message, title bar caption, button, and icon; and
|
|
that returns a result.
|
|
</summary>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
<param name="button">
|
|
A System.Windows.MessageBoxButton value that specifies which button or buttons to
|
|
display.
|
|
</param>
|
|
<param name="icon">
|
|
A System.Windows.MessageBoxImage value that specifies the icon to display.
|
|
</param>
|
|
<param name="defaultResult">
|
|
A System.Windows.MessageBoxResult value that specifies the default result of the
|
|
message box.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.Show(System.Windows.Window,System.String,System.String,System.Windows.MessageBoxButton,System.Windows.MessageBoxImage,System.Windows.MessageBoxResult)">
|
|
<summary>
|
|
Displays a message box in front of the specified window that has a message, title
|
|
bar caption, button, and icon; and that returns a result.
|
|
</summary>
|
|
<param name="owner">
|
|
A System.Windows.Window that represents the owner window of the message box.
|
|
</param>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
<param name="button">
|
|
A System.Windows.MessageBoxButton value that specifies which button or buttons to
|
|
display.
|
|
</param>
|
|
<param name="icon">
|
|
A System.Windows.MessageBoxImage value that specifies the icon to display.
|
|
</param>
|
|
<param name="defaultResult">
|
|
A System.Windows.MessageBoxResult value that specifies the default result of the
|
|
message box.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.MessageBoxResult value that specifies which message box button is
|
|
clicked by the user.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMessageBoxService.ShowStandardErrorBox(System.String,System.String)">
|
|
<summary>
|
|
Shows a standard error message box that has a message, and title. This message box
|
|
displays an okay button and the error icon.
|
|
</summary>
|
|
<param name="messageBoxText">
|
|
A System.String that specifies the text to display.
|
|
</param>
|
|
<param name="caption">
|
|
A System.String that specifies the title bar caption to display.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.ICommandServiceProvider">
|
|
<summary>
|
|
When implemented defines a service provider that can be used by the command
|
|
implementers to retrieve services to use in their execute handlers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ICommandServiceProvider.GetService``1">
|
|
<summary>
|
|
Gets the service object of the specified type.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of service object to get.
|
|
</typeparam>
|
|
<returns>
|
|
A service object of the specified type or null if there is no service object of
|
|
that type.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.IPerforceFileMetaData">
|
|
<summary>
|
|
When implemented contains the metadata values for a file inside of source control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.Action">
|
|
<summary>
|
|
Gets the current users action on this file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.Change">
|
|
<summary>
|
|
Gets the change list number that this file is inside in the current users pending
|
|
change lists if applicable; otherwise, -1.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.ClientPath">
|
|
<summary>
|
|
Gets the location of the file in the clients workspace.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.DepotPath">
|
|
<summary>
|
|
Gets the location of the file in the clients depot system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.HaveRevision">
|
|
<summary>
|
|
Gets the revision index the current user has of this file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.HeadAction">
|
|
<summary>
|
|
Gets the action that was performed on the file at the head revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.HeadRevision">
|
|
<summary>
|
|
Gets the revision index the of this files head revision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.HeadTime">
|
|
<summary>
|
|
Gets the date and time the head revision of the file was submitted.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.IsInClient">
|
|
<summary>
|
|
Gets a value indicating whether the file is inside the clients workspace.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.IsInDepot">
|
|
<summary>
|
|
Gets a value indicating whether the file is inside the clients depot.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.IsMapped">
|
|
<summary>
|
|
Gets a value indicating whether the file is mapped in the clients workspace.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.LocalPath">
|
|
<summary>
|
|
Gets the location of the file in the client's file system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.OtherActions">
|
|
<summary>
|
|
Gets the list containing all of the actions other users are currently performing on
|
|
the file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileMetaData.OtherLock">
|
|
<summary>
|
|
Gets a value indicating whether the file is locked by another user.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.IPerforceFileSpec">
|
|
<summary>
|
|
When implemented contains a perforce file specification that can be represented
|
|
as either a client, depot or local path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileSpec.ClientPath">
|
|
<summary>
|
|
Gets the value that represents the files client path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileSpec.DepotPath">
|
|
<summary>
|
|
Gets the value that represents the files perforce depot path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceFileSpec.LocalPath">
|
|
<summary>
|
|
Gets the value that represents the files local path.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.IPerforceService">
|
|
<summary>
|
|
When implemented represents a service that can be used to handle perforce requests.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IPerforceService.CommandTimeout">
|
|
<summary>
|
|
Gets or sets the perforce command execution timeout.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.AddFiles(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Adds the specified files and puts them into the default change list.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that need adding.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.AddFiles(System.Collections.Generic.IList{System.String},System.Int32)">
|
|
<summary>
|
|
Adds the specified files and puts them into the change list with the specified id.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that need adding.
|
|
</param>
|
|
<param name="changelistId">
|
|
The id of the change list the files should be added to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.AnyFilesWithState(System.Collections.Generic.IList{System.String},RSG.Editor.PerforceFileAction[])">
|
|
<summary>
|
|
Returns which files are checked out locally from the list passed in.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The collection containing the full paths of the files to check.
|
|
</param>
|
|
<param name="actions">
|
|
The actions to test.
|
|
</param>
|
|
<returns>
|
|
True if any of the given files have the actions; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.CreateChangelist(System.String)">
|
|
<summary>
|
|
Creates a new changelist using the specified description.
|
|
</summary>
|
|
<param name="description">
|
|
The description of the change list we are creating.
|
|
</param>
|
|
<returns>
|
|
The id of changelist that was created.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.EditFiles(System.Collections.Generic.IList{System.String},System.String,System.Boolean)">
|
|
<summary>
|
|
Checks out the specified files into a new change list with the specified
|
|
description and optionally adds any file that isn't currently mapped.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that need checking out.
|
|
</param>
|
|
<param name="description">
|
|
The description of the change list the files should be checked out in.
|
|
</param>
|
|
<param name="add">
|
|
A value indicating whether any files currently not mapped should be added.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.EditFiles(System.Collections.Generic.IList{System.String},System.Int32,System.Boolean)">
|
|
<summary>
|
|
Checks out the specified files into the change list with the specified id and
|
|
optionally adds any file that isn't currently mapped.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that need checking out.
|
|
</param>
|
|
<param name="changelistId">
|
|
The id of the change list the files should be checked out in.
|
|
</param>
|
|
<param name="add">
|
|
A value indicating whether any files currently not mapped should be added.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.EditFiles(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Checks out the specified files into the default change list.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that need checking out.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.GetCheckedOutFiles(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Returns which files are checked out locally from the list passed in.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The collection containing the full paths of the files to check.
|
|
</param>
|
|
<returns>
|
|
A list containing the files that are currently checked out out of the specified
|
|
list.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.GetFileContents(System.Collections.Generic.IList{RSG.Editor.IPerforceFileSpec})">
|
|
<summary>
|
|
Gets the contents of the specified list of files.
|
|
</summary>
|
|
<param name="fileSpecs">
|
|
The file specifications for the files to get the contents for.
|
|
</param>
|
|
<returns>
|
|
Mapping of file specifications to streams containing the file contents.
|
|
</returns>
|
|
<remarks>
|
|
The calling code is in charge of disposing of the returned streams.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.GetFileMetaData(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Gets the metadata for the specified list of files. The metadata contains the
|
|
results from the 'fstat' perforce command.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The collection containing the full paths of the files to get.
|
|
</param>
|
|
<returns>
|
|
A list containing the metadata for the specified files.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.GetFileMetaData(System.Collections.Generic.IList{RSG.Editor.IPerforceFileSpec})">
|
|
<summary>
|
|
Gets the metadata for the specified list of files. The metadata contains the
|
|
results from the 'fstat' perforce command.
|
|
</summary>
|
|
<param name="fileSpecs">
|
|
The file specifications for the files to get metadata for.
|
|
</param>
|
|
<returns>
|
|
A list containing the metadata for the specified files.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.GetLatest(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Gets the head revision of the specified files.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that needs to be synced to the head revision.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.GetLatest(System.Collections.Generic.IList{RSG.Editor.IPerforceFileSpec},System.Boolean)">
|
|
<summary>
|
|
Gets (or previews) the head revision of the specified files.
|
|
</summary>
|
|
<param name="fileSpecs">
|
|
The file specifications for the files to get metadata for.
|
|
</param>
|
|
<param name="preview">
|
|
Flag indicating whether we only wish to preview the results of the sync
|
|
operation.
|
|
</param>
|
|
<returns>
|
|
A list containing the metadata for the files that were/would be synced
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.GetLocalPathsFromDepotPaths(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Gets a set of local paths from a set of depot paths.
|
|
</summary>
|
|
<param name="depotPaths">
|
|
The depot paths to convert to local paths.
|
|
</param>
|
|
<returns>
|
|
The list of local paths which correspond to the specified list of depot paths.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.MarkForDelete(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Marks the specified files for deletion.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that are to be mark for delete.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.MoveFilesIntoChangelist(System.Collections.Generic.IList{System.String},System.Int32)">
|
|
<summary>
|
|
Moves the specified files into the specified changelist.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that needs to be synced to the head revision.
|
|
</param>
|
|
<param name="changelistId">
|
|
The id of the changelist to move the files into.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.RevertFiles(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Reverts all of the specified files.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that are to be reverted.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.RevertUnchangedFiles(System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Reverts any of the specified files that are unchanged.
|
|
</summary>
|
|
<param name="fullPaths">
|
|
The full paths to the files that needs to be synced to the head revision.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.SubmitChangelist(System.Int32)">
|
|
<summary>
|
|
Submits the specified changelist.
|
|
</summary>
|
|
<param name="changelistId">
|
|
The id of the changelist to move the files into.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.SuspendExceptionsScope">
|
|
<summary>
|
|
Creates a disposable object whose scope turns the perforce exceptions off.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IPerforceService.TryToDeleteChangelist(System.Int32)">
|
|
<summary>
|
|
Attempts to delete the specified changelist.
|
|
</summary>
|
|
<param name="changelistId">
|
|
The id of the changelist to attempt to delete.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.IProductInfoService">
|
|
<summary>
|
|
When implemented represents a service that can be used to get the product information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IProductInfoService.ProductName">
|
|
<summary>
|
|
Gets the name of the product.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ISaveableDocument">
|
|
<summary>
|
|
When implemented represents a object that's data can be written to a generic stream and
|
|
is itself representing a document contained on the local disk drive.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ISaveableDocument.Filename">
|
|
<summary>
|
|
Gets or sets the filename to use to display this document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ISaveableDocument.FullPath">
|
|
<summary>
|
|
Gets or sets the full file path to the location of this file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ISaveableDocument.IsModified">
|
|
<summary>
|
|
Gets a value indicating whether this document item currently contains modified
|
|
unsaved data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ISaveableDocument.IsReadOnly">
|
|
<summary>
|
|
Gets or sets a value indicating whether this document is currently locked inside
|
|
the windows explorer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ISaveableDocument.IsTemporaryFile">
|
|
<summary>
|
|
Gets a value indicating whether this document represents a temporary document. A
|
|
temporary file cannot be saved to the same location and needs to be "Saved As...".
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ISaveableDocument.UndoEngine">
|
|
<summary>
|
|
Gets the undo engine associated with this document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ISaveable">
|
|
<summary>
|
|
When implemented represents a object that's data can be written to a generic stream.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.ISaveable.Saved">
|
|
<summary>
|
|
Occurs just after this object has been saved successfully.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ISaveable.FriendlySavePath">
|
|
<summary>
|
|
Gets the friendly save path that this item pushes into the command system
|
|
to display on menu items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ISaveable.RaiseSavedEvent">
|
|
<summary>
|
|
Raises the saved event on this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ISaveable.Save(System.IO.Stream)">
|
|
<summary>
|
|
Saves the data that is associated with this item to the specified file.
|
|
</summary>
|
|
<param name="stream">
|
|
The io stream that data for this object should be written to.
|
|
</param>
|
|
<returns>
|
|
A value indicating whether the save operation was successful.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.IUserCreatedCommandBarItem">
|
|
<summary>
|
|
When implemented represents a command bar item that has been created by the user.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.IUserCreatedCommandBarItem.SerialiseCommand(System.Xml.XmlWriter,System.IFormatProvider)">
|
|
<summary>
|
|
Serialises this command to the end of the specified writer.
|
|
</summary>
|
|
<param name="writer">
|
|
The xml writer that the command gets serialised out to.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.DisposableModelBase">
|
|
<summary>
|
|
Provides a abstract class that can be inherited by classes that wish to implement the
|
|
<see cref="T:RSG.Editor.Model.IDisposableModel"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.DisposableModelBase._isDisposed">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.DisposableModelBase.IsDisposed"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.DisposableModelBase.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.DisposableModelBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.DisposableModelBase.#ctor(RSG.Editor.Model.IModel)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.DisposableModelBase"/> class.
|
|
</summary>
|
|
<param name="parent">
|
|
A reference to the parent model used for this model.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.DisposableModelBase.Finalize">
|
|
<summary>
|
|
Finalises an instance of the <see cref="T:RSG.Editor.Model.DisposableModelBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.DisposableModelBase.IsDisposed">
|
|
<summary>
|
|
Gets a value indicating whether this instance has been disposed of.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.DisposableModelBase.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or
|
|
resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.DisposableModelBase.DisposeManagedResources">
|
|
<summary>
|
|
When overridden disposes of the managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.DisposableModelBase.DisposeNativeResources">
|
|
<summary>
|
|
When overridden disposes of the unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.DisposableModelBase.Dispose(System.Boolean)">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or
|
|
resetting unmanaged resources.
|
|
</summary>
|
|
<param name="disposeManaged">
|
|
If true the managed resources for this instance also get disposed of as well as
|
|
the unmanaged resources.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.FieldChange`1">
|
|
<summary>
|
|
Implements the <see cref="T:RSG.Editor.Model.IChange"/> interface for a single field
|
|
change. This can be used when the field type and property type do not match.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of field that has changed.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.FieldChange`1._model">
|
|
<summary>
|
|
The private field used for the <see cref="N:RSG.Editor.Model"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.FieldChange`1._name">
|
|
<summary>
|
|
The name of the property that changed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.FieldChange`1._newValue">
|
|
<summary>
|
|
The new value that the property is set to.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.FieldChange`1._oldValue">
|
|
<summary>
|
|
The old value of the property that changed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.FieldChange`1.#ctor(`0,`0,RSG.Editor.NotifyPropertyChangedBase,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.FieldChange`1"/> class with the
|
|
specified old and new values.
|
|
</summary>
|
|
<param name="oldValue">
|
|
The value of the property before the change.
|
|
</param>
|
|
<param name="newValue">
|
|
The value of the property after the change.
|
|
</param>
|
|
<param name="model">
|
|
The model whose property changed.
|
|
</param>
|
|
<param name="name">
|
|
The name of the property that changed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.FieldChange`1.Redo">
|
|
<summary>
|
|
Redoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.FieldChange`1.Undo">
|
|
<summary>
|
|
Undoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.FieldChange`1.SetProperty(`0)">
|
|
<summary>
|
|
Sets the field that this change is associated with to the specified value.
|
|
</summary>
|
|
<param name="value">
|
|
The value to set the field that is associated with this change.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.FileLocation">
|
|
<summary>
|
|
Represents a location of a validation result.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.FileLocation._notApplicable">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.FileLocation.NotApplicable"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.FileLocation._column">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.FileLocation.Column"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.FileLocation._fullPath">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.FileLocation.FullPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.FileLocation._line">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.FileLocation.Line"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.FileLocation.#cctor">
|
|
<summary>
|
|
Initialises static members of the <see cref="T:RSG.Editor.Model.FileLocation"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.FileLocation.#ctor(System.Int32,System.Int32,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.FileLocation"/> class.
|
|
</summary>
|
|
<param name="line">
|
|
The line number for this location.
|
|
</param>
|
|
<param name="column">
|
|
The column index for this location.
|
|
</param>
|
|
<param name="fullPath">
|
|
The full path for this location.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.FileLocation.NotApplicable">
|
|
<summary>
|
|
Gets the instance of this object that represents a empty location that can be set
|
|
when the location is not applicable to the situation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.FileLocation.Column">
|
|
<summary>
|
|
Gets or sets the column index for this location.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.FileLocation.FullPath">
|
|
<summary>
|
|
Gets or sets the full path to the file this location is representing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.FileLocation.Line">
|
|
<summary>
|
|
Gets or sets the line number for this location.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.IDisposableModel">
|
|
<summary>
|
|
When implemented represents a model (data source) object in the Editor Framework that
|
|
can be disposed of.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.IPropertyValidation">
|
|
<summary>
|
|
When implemented represents a item that describes a situation that has been found
|
|
through validating a model object that is associated with a individual property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.IPropertyValidation.PropertyName">
|
|
<summary>
|
|
Gets the name of the property this validation item is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.IUndoEngineProvider">
|
|
<summary>
|
|
When implemented represents a object that can be used to retrieve a instance of the
|
|
<see cref="P:RSG.Editor.Model.IUndoEngineProvider.UndoEngine"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.IUndoEngineProvider.UndoEngine">
|
|
<summary>
|
|
Gets the instance of the <see cref="T:RSG.Editor.Model.UndoEngine"/> class that this
|
|
object is using as its undo engine.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.IValidationItem">
|
|
<summary>
|
|
When implemented represents a item that describes a situation that has been found
|
|
through validating a model object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.IValidationItem.HasLocationInformation">
|
|
<summary>
|
|
Gets a value indicating whether this object can provide information about the
|
|
location of the validation item inside a file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.IValidationItem.Location">
|
|
<summary>
|
|
Gets the file location that this error is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.IValidationItem.Message">
|
|
<summary>
|
|
Gets the message that describes the error.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.IValidationError">
|
|
<summary>
|
|
When implemented represents a object that describes a error that has been found through
|
|
validating a model object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.IValidationWarning">
|
|
<summary>
|
|
When implemented represents a object that describes a warning that has been found
|
|
through validating a model object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ModelCollectionExtensions">
|
|
<summary>
|
|
Provides extensions onto the <see cref="T:RSG.Editor.Model.ModelCollection`1"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollectionExtensions.ToReadOnly``1(RSG.Editor.Model.ModelCollection{``0})">
|
|
<summary>
|
|
Creates a read-only version of this model collection.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type parameter of the collection being created.
|
|
</typeparam>
|
|
<param name="collection">
|
|
The collection to create a read-only version of.
|
|
</param>
|
|
<returns>
|
|
A new instance of a read-only model collection that uses this collection as its
|
|
inner collection.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.PropertyValidationError">
|
|
<summary>
|
|
Represents a error that has occurred during validation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.PropertyValidationError._propertyName">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.PropertyValidationError.PropertyName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.PropertyValidationError.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.PropertyValidationError"/> class.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property that this error is associated with.
|
|
</param>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.PropertyValidationError.#ctor(System.String,System.String,RSG.Editor.Model.FileLocation)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.PropertyValidationError"/> class.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property that this error is associated with.
|
|
</param>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
<param name="location">
|
|
The file location for the error if applicable.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.PropertyValidationError.PropertyName">
|
|
<summary>
|
|
Gets the name of the property this validation item is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.PropertyValidationWarning">
|
|
<summary>
|
|
Represents a warning that has occurred during validation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.PropertyValidationWarning._propertyName">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.PropertyValidationWarning.PropertyName"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.PropertyValidationWarning.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.PropertyValidationWarning"/> class.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property that this warning is associated with.
|
|
</param>
|
|
<param name="message">
|
|
The message that describes the warning.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.PropertyValidationWarning.#ctor(System.String,System.String,RSG.Editor.Model.FileLocation)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.PropertyValidationWarning"/> class.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property that this warning is associated with.
|
|
</param>
|
|
<param name="message">
|
|
The message that describes the warning.
|
|
</param>
|
|
<param name="location">
|
|
The file location for the warning if applicable.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.PropertyValidationWarning.PropertyName">
|
|
<summary>
|
|
Gets the name of the property this validation item is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.SuspendUndoEngine">
|
|
<summary>
|
|
Provides functionality so that a undo engine can be suspended from creating any undo
|
|
events. The engine will still perform any Undo or Redo operations and those operations
|
|
will create the necessary alteration event still.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.SuspendUndoEngine._engine">
|
|
<summary>
|
|
Gets the <see cref="T:RSG.Editor.Model.UndoEngine"/> instance that this batch was
|
|
created for.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.SuspendUndoEngine._mode">
|
|
<summary>
|
|
The private value indicating the suspended mode this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.SuspendUndoEngine.#ctor(RSG.Editor.Model.UndoEngine)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.SuspendUndoEngine"/> class.
|
|
</summary>
|
|
<param name="engine">
|
|
A instance of the <see cref="T:RSG.Editor.Model.UndoEngine"/> that this suspend
|
|
region will be applied on.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.SuspendUndoEngine.#ctor(RSG.Editor.Model.UndoEngine,RSG.Editor.Model.SuspendUndoEngineMode)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.SuspendUndoEngine"/> class.
|
|
</summary>
|
|
<param name="engine">
|
|
A instance of the <see cref="T:RSG.Editor.Model.UndoEngine"/> that this suspend
|
|
region will be applied on.
|
|
</param>
|
|
<param name="mode">
|
|
The mode in which the undo engine should be suspended.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.SuspendUndoEngine.DisposeManagedResources">
|
|
<summary>
|
|
Finishes the suspended state that this object represents on the associated engine.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.SuspendUndoEngineMode">
|
|
<summary>
|
|
Defines the different modes that can be undo engine can be suspended under.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.SuspendUndoEngineMode.UndoEvents">
|
|
<summary>
|
|
Defines that the undo engine shouldn't produce any undo events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.SuspendUndoEngineMode.DirtyState">
|
|
<summary>
|
|
Defines that the undo engine shouldn't change its dirty state.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.SuspendUndoEngineMode.Both">
|
|
<summary>
|
|
Defines that the undo engine shouldn't produce any undo events or change its dirty
|
|
state.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.UndoablePropertyChangedBase">
|
|
<summary>
|
|
Provides an abstract class that can be inherited by classes that wish to
|
|
implement the <see cref="T:System.ComponentModel.INotifyPropertyChanged"/>
|
|
interface as well as support undo redo functionality.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoablePropertyChangedBase._undoEngineProvider">
|
|
<summary>
|
|
Reference to the undo engine provider instance that this object uses.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoablePropertyChangedBase.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoablePropertyChangedBase"/>
|
|
class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoablePropertyChangedBase.#ctor(RSG.Editor.Model.IUndoEngineProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoablePropertyChangedBase"/>
|
|
class using the specified undo engine provider.
|
|
</summary>
|
|
<param name="undoEngineProvider">
|
|
Gets the undo engine provider instance that this class uses.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoablePropertyChangedBase.UndoEngine">
|
|
<summary>
|
|
Gets the undo engine this object should use to store changes in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoablePropertyChangedBase.UndoEngineProvider">
|
|
<summary>
|
|
Gets the undo engine provider instance that this class uses.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoablePropertyChangedBase.SetUndoableProperty``1(``0@,``0,System.String)">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="name">
|
|
The name of the property that has been changed.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoablePropertyChangedBase.SetUndoableProperty``1(``0@,``0,System.Collections.Generic.IEqualityComparer{``0},System.String)">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="comparer">
|
|
The equality comparer to use to determine whether the value has changed.
|
|
</param>
|
|
<param name="name">
|
|
The name of the property that has been changed.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoablePropertyChangedBase.SetUndoableProperty``1(``0@,``0,System.String[])">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="names">
|
|
An array of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoablePropertyChangedBase.SetUndoableProperty``1(``0@,``0,System.Collections.Generic.IEqualityComparer{``0},System.String[])">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="comparer">
|
|
The equality comparer to use to determine whether the value has changed.
|
|
</param>
|
|
<param name="names">
|
|
An array of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoablePropertyChangedBase.SetUndoableProperty``1(``0@,``0,System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="names">
|
|
A iterator around all of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoablePropertyChangedBase.SetUndoableProperty``1(``0@,``0,System.Collections.Generic.IEqualityComparer{``0},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="comparer">
|
|
The equality comparer to use to determine whether the value has changed.
|
|
</param>
|
|
<param name="names">
|
|
A iterator around all of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ValidationError">
|
|
<summary>
|
|
Represents a error that has occurred during validation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ValidationError._location">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.ValidationError.Location"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ValidationError._message">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.ValidationError.Message"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationError.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ValidationError"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationError.#ctor(System.String,RSG.Editor.Model.FileLocation)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ValidationError"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
<param name="location">
|
|
The file location for the error if applicable.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationError.HasLocationInformation">
|
|
<summary>
|
|
Gets a value indicating whether this object can provide information about the
|
|
location of the error inside a file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationError.Location">
|
|
<summary>
|
|
Gets the file location that this error is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationError.Message">
|
|
<summary>
|
|
Gets the message that describes the error.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ValidationResult">
|
|
<summary>
|
|
Contains the results of a model validation, which include the validation results per
|
|
property as well as for the entire entity.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ValidationResult._empty">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.ValidationResult.Empty"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ValidationResult._childResults">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.ValidationResult.ChildResults"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ValidationResult._errors">
|
|
<summary>
|
|
The private list containing the errors that have been found during the validation
|
|
process.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ValidationResult._warnings">
|
|
<summary>
|
|
The private list containing the warnings that have been found during the validation
|
|
process.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.#cctor">
|
|
<summary>
|
|
Initialises static members of the <see cref="T:RSG.Editor.Model.ValidationResult"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ValidationResult"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationResult.Empty">
|
|
<summary>
|
|
Gets the instance of this object that represents validation with no results.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationResult.AllUniqueErrors">
|
|
<summary>
|
|
Gets a hash set containing all of the unique errors inside this container
|
|
independent on property name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationResult.ChildResults">
|
|
<summary>
|
|
Gets a iterator around the child result containers for this result container.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationResult.Errors">
|
|
<summary>
|
|
Gets a iterator around the errors contained within this result container.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationResult.HasErrors">
|
|
<summary>
|
|
Gets a value indicating whether this result contains has validation errors.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationResult.PropertyNames">
|
|
<summary>
|
|
Gets the property names that have data about them in this validation results
|
|
object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationResult.Warnings">
|
|
<summary>
|
|
Gets a iterator around the warnings contained within this result container.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddChildResults(RSG.Editor.Model.ValidationResult)">
|
|
<summary>
|
|
Adds a child validation results container to this container.
|
|
</summary>
|
|
<param name="childResult">
|
|
The child results to add to this container.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddError(System.String,System.String,RSG.Editor.Model.FileLocation)">
|
|
<summary>
|
|
Adds a new property error into this results container for a property with the
|
|
specified name, description, and location.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property the error is associated with.
|
|
</param>
|
|
<param name="error">
|
|
The description of the error.
|
|
</param>
|
|
<param name="location">
|
|
The file location of the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddError(System.String,System.String)">
|
|
<summary>
|
|
Adds a new property error into this results container for a property with the
|
|
specified name and description.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property the error is associated with.
|
|
</param>
|
|
<param name="error">
|
|
The description of the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddError(System.String,RSG.Editor.Model.FileLocation)">
|
|
<summary>
|
|
Adds a new property error into this results container for a property with the
|
|
specified description and location.
|
|
</summary>
|
|
<param name="error">
|
|
The description of the error.
|
|
</param>
|
|
<param name="location">
|
|
The file location of the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddError(System.String)">
|
|
<summary>
|
|
Adds a new property error into this results container for a property with the
|
|
specified description.
|
|
</summary>
|
|
<param name="error">
|
|
The description of the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddWarning(System.String,System.String,RSG.Editor.Model.FileLocation)">
|
|
<summary>
|
|
Adds a new property warning into this results container for a property with the
|
|
specified name, description, and location.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property the warning is associated with.
|
|
</param>
|
|
<param name="warning">
|
|
The description of the warning.
|
|
</param>
|
|
<param name="location">
|
|
The file location of the warning.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddWarning(System.String,System.String)">
|
|
<summary>
|
|
Adds a new property warning into this results container for a property with the
|
|
specified name and description.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property the warning is associated with.
|
|
</param>
|
|
<param name="warning">
|
|
The description of the warning.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddWarning(System.String,RSG.Editor.Model.FileLocation)">
|
|
<summary>
|
|
Adds a new property warning into this results container for a property with the
|
|
specified description and location.
|
|
</summary>
|
|
<param name="warning">
|
|
The description of the warning.
|
|
</param>
|
|
<param name="location">
|
|
The file location of the warning.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.AddWarning(System.String)">
|
|
<summary>
|
|
Adds a new property warning into this results container for a property with the
|
|
specified description.
|
|
</summary>
|
|
<param name="warning">
|
|
The description of the warning.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.GetErrors(System.String)">
|
|
<summary>
|
|
Gets the validation errors for a specified property or for the entire entity.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property to retrieve validation errors for; or null or Empty, to
|
|
retrieve entity-level errors.
|
|
</param>
|
|
<returns>
|
|
The validation errors for the property or entity.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationResult.GetErrorsIncludingChildren">
|
|
<summary>
|
|
Gets all of the errors contained within this validation container and its child
|
|
containers recursively.
|
|
</summary>
|
|
<returns>
|
|
All of the erros contained within this validation container.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ValidationWarning">
|
|
<summary>
|
|
Represents a warning that has occurred during validation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ValidationWarning._location">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.ValidationWarning.Location"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ValidationWarning._message">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.ValidationWarning.Message"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationWarning.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ValidationWarning"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the warning.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ValidationWarning.#ctor(System.String,RSG.Editor.Model.FileLocation)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ValidationWarning"/> class.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the warning.
|
|
</param>
|
|
<param name="location">
|
|
The file location for the warning if applicable.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationWarning.HasLocationInformation">
|
|
<summary>
|
|
Gets a value indicating whether this object can provide information about the
|
|
location of the warning inside a file.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationWarning.Location">
|
|
<summary>
|
|
Gets the file location that this warning is associated with.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ValidationWarning.Message">
|
|
<summary>
|
|
Gets the message that describes the warning.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ReadOnlyModelCollection`1">
|
|
<summary>
|
|
Represents a collection of objects that can be access via a index or iterated over.
|
|
Also supports notifications and undo / redo.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of elements in the collection.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ReadOnlyModelCollection`1._internalList">
|
|
<summary>
|
|
The private list that is used as the internal data for the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ReadOnlyModelCollection`1._syncRoot">
|
|
<summary>
|
|
A generic object used to synchronize access to the items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.#ctor(RSG.Editor.Model.ModelCollection{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ReadOnlyModelCollection`1"/> class.
|
|
</summary>
|
|
<param name="innerCollection">
|
|
The inner model collection that this readonly collection wraps.
|
|
</param>
|
|
</member>
|
|
<member name="E:RSG.Editor.Model.ReadOnlyModelCollection`1.CollectionChanged">
|
|
<summary>
|
|
Occurs when the collection changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ReadOnlyModelCollection`1.Count">
|
|
<summary>
|
|
Gets the number of elements contained in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ReadOnlyModelCollection`1.IsReadOnly">
|
|
<summary>
|
|
Gets a value indicating whether the collection is read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ReadOnlyModelCollection`1.UndoEngineProvider">
|
|
<summary>
|
|
Gets the undo engine provider instance that this collection uses.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ReadOnlyModelCollection`1.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the element at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the element to get or set.
|
|
</param>
|
|
<returns>
|
|
The element at the specified index.
|
|
</returns>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown on set.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Add(`0)">
|
|
<summary>
|
|
Adds an item to the end of the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to add to the collection.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.AddRange(System.Collections.Generic.IList{`0})">
|
|
<summary>
|
|
Adds multiple items to the end of the collection.
|
|
</summary>
|
|
<param name="items">
|
|
The list of items that should be added to the collection.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.AddRange(System.Collections.IList)">
|
|
<summary>
|
|
Adds multiple items to the end of the collection.
|
|
</summary>
|
|
<param name="items">
|
|
The list of items that should be added to the collection.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Clear">
|
|
<summary>
|
|
Removes all items from the collection.
|
|
</summary>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Contains(`0)">
|
|
<summary>
|
|
Determines whether the collection contains a specific value.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in the collection.
|
|
</param>
|
|
<returns>
|
|
True if item is found in the collection; otherwise false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.CopyTo(`0[],System.Int32)">
|
|
<summary>
|
|
Copies the elements of the collection to an System.Array, starting at a
|
|
particular index.
|
|
</summary>
|
|
<param name="array">
|
|
The one-dimensional System.Array that is the destination of the elements.
|
|
</param>
|
|
<param name="arrayIndex">
|
|
The zero-based index in array at which copying begins.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>
|
|
A System.Collections.Generic.IEnumerator{T} that can be used to iterate through the
|
|
collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>
|
|
A System.Collections.Generic.IEnumerator{T} that can be used to iterate through the
|
|
collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.IndexOf(`0)">
|
|
<summary>
|
|
Determines the index of a specific item in the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in the collection.
|
|
</param>
|
|
<returns>
|
|
The index of item if found in the list; otherwise, -1.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Insert(System.Int32,`0)">
|
|
<summary>
|
|
Inserts the specified item into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index at which item should be inserted.
|
|
</param>
|
|
<param name="item">
|
|
The object to insert into the collection.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Insert(System.Int32,System.Collections.Generic.IList{`0})">
|
|
<summary>
|
|
Inserts the specified item into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index at which item should be inserted.
|
|
</param>
|
|
<param name="items">
|
|
The objects to insert into the collection.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Insert(System.Int32,System.Collections.IList)">
|
|
<summary>
|
|
Inserts multiple items into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The non-zero index where the items should be inserted.
|
|
</param>
|
|
<param name="items">
|
|
The list of items that should be added to the collection.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Move(System.Int32,System.Int32)">
|
|
<summary>
|
|
Moves the item at the specified index to a new location in the collection.
|
|
</summary>
|
|
<param name="oldIndex">
|
|
The zero-based index specifying the location of the item to be moved.
|
|
</param>
|
|
<param name="newIndex">
|
|
The zero-based index specifying the new location of the item.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Move(`0,System.Int32)">
|
|
<summary>
|
|
Moves the first occurrence of the specified item to the specified index.
|
|
</summary>
|
|
<param name="item">
|
|
The item that should be moved.
|
|
</param>
|
|
<param name="newIndex">
|
|
The zero-based index specifying the new location of the item.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Remove(`0)">
|
|
<summary>
|
|
Removes the first occurrence of a specific object from the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to remove from the collection.
|
|
</param>
|
|
<returns>
|
|
True if item was successfully removed from the collection, otherwise, false. This
|
|
method also returns false if item is not found in the original collection.
|
|
</returns>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the item at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the item to remove.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.RemoveRange(System.Int32,System.Int32)">
|
|
<summary>
|
|
Removes a range of elements from the collection.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index specifying the starting location of the items to be removed.
|
|
</param>
|
|
<param name="count">
|
|
The number of elements to remove.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Replace(`0,`0)">
|
|
<summary>
|
|
Replaces the first occurrence of the specified old item with the
|
|
specified new item.
|
|
</summary>
|
|
<param name="oldItem">
|
|
The item that is going to be replaced.
|
|
</param>
|
|
<param name="newItem">
|
|
The item that is going to be replacing the old item.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.Replace(System.Int32,`0)">
|
|
<summary>
|
|
Adds an item to the end of the collection.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index specifying the location of the item to be replaced.
|
|
</param>
|
|
<param name="newItem">
|
|
The item that is going to be replacing the old item.
|
|
</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.OnCollectionChange(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
|
|
<summary>
|
|
Forwards the collection changes from the internal collection to any handles
|
|
attached to this collection.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.Collections.Specialized.NotifyCollectionChangedEventArgs data used for
|
|
the event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.OnPropertyChange(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Forwards the property changes from the internal collection to any handles attached
|
|
to this collection.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs data used for the event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ReadOnlyModelCollection`1.ThrowReadOnlyException">
|
|
<summary>
|
|
Throws the exception when a user tries to modify this collection directly.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ChangeBase">
|
|
<summary>
|
|
Provides a abstract base class for objects wanted to implement the
|
|
<see cref="T:RSG.Editor.Model.IChange"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ChangeBase.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ChangeBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ChangeBase.Redo">
|
|
<summary>
|
|
Redoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ChangeBase.Undo">
|
|
<summary>
|
|
Undoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.CollectionChange`1">
|
|
<summary>
|
|
Implements the <see cref="T:RSG.Editor.Model.IChange"/> interface for a single collection
|
|
change.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the item that is contained in the collection that has changed.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.CollectionChange`1._action">
|
|
<summary>
|
|
The action that was performed to change the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.CollectionChange`1._collection">
|
|
<summary>
|
|
A private reference to the collection that has changed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.CollectionChange`1._newIndex">
|
|
<summary>
|
|
The starting index in the collection that any new items were added at.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.CollectionChange`1._newItems">
|
|
<summary>
|
|
A list of items that were added to the collection during the change.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.CollectionChange`1._oldIndex">
|
|
<summary>
|
|
The starting index in the collection that any items that were removed started at.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.CollectionChange`1._oldItems">
|
|
<summary>
|
|
A list of items that were removed from the collection during the change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.CollectionChange`1.#ctor(RSG.Editor.Model.ModelCollection{`0},System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.CollectionChange`1"/> class with the
|
|
specified action on the specified items at the specified index.
|
|
</summary>
|
|
<param name="collection">
|
|
The reference to the collection that this change is on.
|
|
</param>
|
|
<param name="args">
|
|
A instance of the argument class that is used to describe the change that has
|
|
occurred.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.CollectionChange`1.Redo">
|
|
<summary>
|
|
Redoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.CollectionChange`1.Undo">
|
|
<summary>
|
|
Undoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.IChange">
|
|
<summary>
|
|
Represents a single change within a undo event that provides methods to undo and redo
|
|
the change that took place.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.IChange.Redo">
|
|
<summary>
|
|
Redoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.IChange.Undo">
|
|
<summary>
|
|
Undoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.IModel">
|
|
<summary>
|
|
When implemented represents a model (data source) object in the Editor Framework.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.IModel.CanReload">
|
|
<summary>
|
|
Gets a value indicating whether this model can be reloaded from the source that
|
|
initialised it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.IModel.Parent">
|
|
<summary>
|
|
Gets a reference to this instances parent model object inside a model hierarchy if
|
|
appropriate so that the undo engine can be set once on the root.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.IModel.RootParent">
|
|
<summary>
|
|
Gets the top most model in the hierarchy this this model belongs to.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.IModel.ChangeParent(RSG.Editor.Model.IModel)">
|
|
<summary>
|
|
Changes the parent for this object to the one specified.
|
|
</summary>
|
|
<param name="newParent">
|
|
The new parent for this object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.IModel.NotifyPropertyChanged(System.String[])">
|
|
<summary>
|
|
Fires the property changed event for the specified property names.
|
|
</summary>
|
|
<param name="names">
|
|
A array of property names that have been changed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.IModel.ReloadModel">
|
|
<summary>
|
|
Reloads the model from whichever source it was initialised with.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.IModel.Validate(System.Boolean)">
|
|
<summary>
|
|
Validates this entity and creates a validation result object containing the errors
|
|
and warnings.
|
|
</summary>
|
|
<param name="recursive">
|
|
A value indicating whether any child models to this one should also be validated.
|
|
</param>
|
|
<returns>
|
|
A validation result object containing all of the errors and warnings associated
|
|
with this validation pass.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.IModel.Validate(RSG.Base.Logging.ILog,System.Boolean)">
|
|
<summary>
|
|
Validates this entity and adds the errors and warnings to the specified log object.
|
|
</summary>
|
|
<param name="log">
|
|
The log object the errors and warnings for this entity should be added.
|
|
</param>
|
|
<param name="recursive">
|
|
A value indicating whether any child models to this one should also be validated.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ModelBase">
|
|
<summary>
|
|
Provides a abstract class that can be inherited by classes that wish to implement the
|
|
<see cref="T:RSG.Editor.Model.IModel"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ModelBase._parent">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.ModelBase.Parent"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ModelBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.#ctor(RSG.Editor.Model.IModel)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ModelBase"/> class.
|
|
</summary>
|
|
<param name="parent">
|
|
A reference to the parent model used for this model.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelBase.CanReload">
|
|
<summary>
|
|
Gets a value indicating whether this model can be reloaded from the source that
|
|
initialised it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelBase.Parent">
|
|
<summary>
|
|
Gets a reference to this instances parent model object inside a model hierarchy if
|
|
appropriate so that the undo engine can be set once on the root.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelBase.RootParent">
|
|
<summary>
|
|
Gets the top most model in the hierarchy this this model belongs to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelBase.UndoEngine">
|
|
<summary>
|
|
Gets the instance of the <see cref="T:RSG.Editor.Model.UndoEngine"/> class that this
|
|
object is using as its undo engine.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.ChangeParent(RSG.Editor.Model.IModel)">
|
|
<summary>
|
|
Changes the parent for this object to the one specified.
|
|
</summary>
|
|
<param name="newParent">
|
|
The new parent for this object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.Clone">
|
|
<summary>
|
|
Creates a new object that is a deep copy of the current instance.
|
|
</summary>
|
|
<returns>
|
|
A new object that is a deep copy of this instance.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.DeepClone">
|
|
<summary>
|
|
Creates a deep copy of the current instance.
|
|
</summary>
|
|
<returns>
|
|
A deep copy of the current System.Object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.Equals(RSG.Editor.Model.IModel)">
|
|
<summary>
|
|
Indicates whether the current object is equal to another object of the same type.
|
|
</summary>
|
|
<param name="other">
|
|
An object to compare with this object.
|
|
</param>
|
|
<returns>
|
|
True if the current object is equal to the other parameter; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.ReloadModel">
|
|
<summary>
|
|
Reloads the model from whichever source it was initialised with.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.Validate(System.Boolean)">
|
|
<summary>
|
|
Validates this entity and creates a validation result object containing the errors
|
|
and warnings.
|
|
</summary>
|
|
<param name="recursive">
|
|
A value indicating whether any child models to this one should also be validated.
|
|
</param>
|
|
<returns>
|
|
A validation result object containing all of the errors and warnings associated
|
|
with this validation pass.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.Validate(RSG.Base.Logging.ILog,System.Boolean)">
|
|
<summary>
|
|
Validates this entity and adds the errors and warnings to the specified log object.
|
|
</summary>
|
|
<param name="log">
|
|
The log object the errors and warnings for this entity should be added.
|
|
</param>
|
|
<param name="recursive">
|
|
A value indicating whether any child models to this one should also be validated.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.ShallowClone">
|
|
<summary>
|
|
Creates a shallow copy of the current instance.
|
|
</summary>
|
|
<returns>
|
|
A shallow copy of the current System.Object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.AddValidationResultToLog(RSG.Editor.Model.ValidationResult,RSG.Base.Logging.ILog)">
|
|
<summary>
|
|
Adds the errors and warnings that are currently inside the specified results object
|
|
into the specified log object.
|
|
</summary>
|
|
<param name="result">
|
|
The validation results object containing all of the errors and warnings.
|
|
</param>
|
|
<param name="log">
|
|
The log object to add the errors and warning to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.EqualsCore(RSG.Editor.Model.IModel)">
|
|
<summary>
|
|
Indicates whether the current object is equal to the specified object. When this
|
|
method is called it has already been determined that the specified object is not
|
|
equal to the current object or null through reference equality.
|
|
</summary>
|
|
<param name="other">
|
|
An object to compare with this object.
|
|
</param>
|
|
<returns>
|
|
True if the current object is equal to the other parameter; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.OnParentChanged(RSG.Editor.Model.IModel,RSG.Editor.Model.IModel)">
|
|
<summary>
|
|
Override to handle the logic whenever the parent for this object has been changed
|
|
after initialisation.
|
|
</summary>
|
|
<param name="oldValue">
|
|
The old parent object.
|
|
</param>
|
|
<param name="newValue">
|
|
The new parent object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.ReloadModelCore">
|
|
<summary>
|
|
Reloads the model from whichever source it was initialised with. This method is
|
|
only called if the <see cref="P:RSG.Editor.Model.ModelBase.CanReload"/> property returns true.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.SetField``1(``0@,``0,System.String)">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="name">
|
|
The name of the property that has been changed.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
<remarks>
|
|
This only works if the name of the field is in the format "_{property_name}".
|
|
</remarks>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.SetProperty``1(``0@,``0,System.Collections.Generic.IEqualityComparer{``0},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="comparer">
|
|
The equality comparer to use to determine whether the value has changed.
|
|
</param>
|
|
<param name="names">
|
|
A iterator around all of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelBase.SetField``1(``0@,``0,System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="names">
|
|
A iterator around all of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the field was changed; otherwise, false.
|
|
</returns>
|
|
<remarks>
|
|
This only works if the name of the field is in the format "_{property_name}".
|
|
</remarks>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ModelCollectionEnumerator`1">
|
|
<summary>
|
|
The enumerator that is used to iterate over a
|
|
<see cref="T:RSG.Editor.Model.ModelCollection`1"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the items that the enumerator will be iterating through.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ModelCollectionEnumerator`1._enumerator">
|
|
<summary>
|
|
The private un-typed enumerator to warp around.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollectionEnumerator`1.#ctor(System.Collections.IEnumerator)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ModelCollectionEnumerator`1"/> class.
|
|
</summary>
|
|
<param name="enumerator">
|
|
The un-typed enumerator to cast from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelCollectionEnumerator`1.Current">
|
|
<summary>
|
|
Gets the element in the collection at the current position of the enumerator.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelCollectionEnumerator`1.System#Collections#IEnumerator#Current">
|
|
<summary>
|
|
Gets the current element in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollectionEnumerator`1.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or
|
|
resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollectionEnumerator`1.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the collection.
|
|
</summary>
|
|
<returns>
|
|
True if the enumerator was successfully advanced to the next element; false if
|
|
the enumerator has passed the end of the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollectionEnumerator`1.Reset">
|
|
<summary>
|
|
Sets the enumerator to its initial position, which is before the first element
|
|
in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.ModelCollection`1">
|
|
<summary>
|
|
Represents a collection of objects that can be access via a index or iterated over.
|
|
Also supports notifications and undo / redo.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of elements in the collection.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ModelCollection`1._internalList">
|
|
<summary>
|
|
The private list that is used as the internal data for the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.ModelCollection`1._undoEngineProvider">
|
|
<summary>
|
|
This private field used for the <see cref="P:RSG.Editor.Model.ModelCollection`1.UndoEngineProvider"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ModelCollection`1"/> class without an
|
|
initial undo engine provider.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.#ctor(RSG.Editor.Model.IUndoEngineProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ModelCollection`1"/> class.
|
|
</summary>
|
|
<param name="undoProvider">
|
|
Gets the undo engine provider instance that this collection uses.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.#ctor(RSG.Editor.Model.IUndoEngineProvider,System.Int32)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ModelCollection`1"/> class.
|
|
</summary>
|
|
<param name="undoProvider">
|
|
Gets the undo engine provider instance that this collection uses.
|
|
</param>
|
|
<param name="capacity">
|
|
The number of elements that the new list can initially store.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ModelCollection`1"/> class as a
|
|
wrapper for the specified list.
|
|
</summary>
|
|
<param name="collection">
|
|
The collection whose elements are copied to the new list.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.#ctor(RSG.Editor.Model.IUndoEngineProvider,System.Collections.Generic.IEnumerable{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.ModelCollection`1"/> class as a
|
|
wrapper for the specified list.
|
|
</summary>
|
|
<param name="undoProvider">
|
|
Gets the undo engine provider instance that this collection uses.
|
|
</param>
|
|
<param name="collection">
|
|
The collection whose elements are copied to the new list.
|
|
</param>
|
|
</member>
|
|
<member name="E:RSG.Editor.Model.ModelCollection`1.CollectionChanged">
|
|
<summary>
|
|
Occurs when the collection changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelCollection`1.Count">
|
|
<summary>
|
|
Gets the number of elements contained in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelCollection`1.IsReadOnly">
|
|
<summary>
|
|
Gets a value indicating whether the collection is read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelCollection`1.UndoEngineProvider">
|
|
<summary>
|
|
Gets the undo engine provider instance that this collection uses.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelCollection`1.UndoEngine">
|
|
<summary>
|
|
Gets the undo engine this collection should use to store changes in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.ModelCollection`1.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the element at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the element to get or set.
|
|
</param>
|
|
<returns>
|
|
The element at the specified index.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Add(`0)">
|
|
<summary>
|
|
Adds an item to the end of the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to add to the collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
|
|
<summary>
|
|
Adds multiple items to the end of the collection.
|
|
</summary>
|
|
<param name="items">
|
|
The list of items that should be added to the collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.AddRange(System.Collections.IEnumerable)">
|
|
<summary>
|
|
Adds multiple items to the end of the collection.
|
|
</summary>
|
|
<param name="items">
|
|
The list of items that should be added to the collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Clear">
|
|
<summary>
|
|
Removes all items from the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Contains(`0)">
|
|
<summary>
|
|
Determines whether the collection contains a specific value.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in the collection.
|
|
</param>
|
|
<returns>
|
|
True if item is found in the collection; otherwise false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.CopyTo(`0[],System.Int32)">
|
|
<summary>
|
|
Copies the elements of the collection to an System.Array, starting at a
|
|
particular index.
|
|
</summary>
|
|
<param name="array">
|
|
The one-dimensional System.Array that is the destination of the elements.
|
|
</param>
|
|
<param name="arrayIndex">
|
|
The zero-based index in array at which copying begins.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>
|
|
A System.Collections.Generic.IEnumerator{T} that can be used to iterate through the
|
|
collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>
|
|
A System.Collections.Generic.IEnumerator{T} that can be used to iterate through the
|
|
collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.IndexOf(`0)">
|
|
<summary>
|
|
Determines the index of a specific item in the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in the collection.
|
|
</param>
|
|
<returns>
|
|
The index of item if found in the list; otherwise, -1.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Insert(System.Int32,`0)">
|
|
<summary>
|
|
Inserts the specified item into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index at which item should be inserted.
|
|
</param>
|
|
<param name="item">
|
|
The object to insert into the collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Insert(System.Int32,System.Collections.Generic.IList{`0})">
|
|
<summary>
|
|
Inserts the specified item into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index at which item should be inserted.
|
|
</param>
|
|
<param name="items">
|
|
The objects to insert into the collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Insert(System.Int32,System.Collections.IList)">
|
|
<summary>
|
|
Inserts multiple items into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The non-zero index where the items should be inserted.
|
|
</param>
|
|
<param name="items">
|
|
The list of items that should be added to the collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Move(System.Int32,System.Int32)">
|
|
<summary>
|
|
Moves the item at the specified index to a new location in the collection.
|
|
</summary>
|
|
<param name="oldIndex">
|
|
The zero-based index specifying the location of the item to be moved.
|
|
</param>
|
|
<param name="newIndex">
|
|
The zero-based index specifying the new location of the item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Move(`0,System.Int32)">
|
|
<summary>
|
|
Moves the first occurrence of the specified item to the specified index.
|
|
</summary>
|
|
<param name="item">
|
|
The item that should be moved.
|
|
</param>
|
|
<param name="newIndex">
|
|
The zero-based index specifying the new location of the item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Remove(`0)">
|
|
<summary>
|
|
Removes the first occurrence of a specific object from the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to remove from the collection.
|
|
</param>
|
|
<returns>
|
|
True if item was successfully removed from the collection, otherwise, false. This
|
|
method also returns false if item is not found in the original collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the item at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the item to remove.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.RemoveRange(System.Int32,System.Int32)">
|
|
<summary>
|
|
Removes a range of elements from the collection.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index specifying the starting location of the items to be removed.
|
|
</param>
|
|
<param name="count">
|
|
The number of elements to remove.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Replace(`0,`0)">
|
|
<summary>
|
|
Replaces the first occurrence of the specified old item with the
|
|
specified new item.
|
|
</summary>
|
|
<param name="oldItem">
|
|
The item that is going to be replaced.
|
|
</param>
|
|
<param name="newItem">
|
|
The item that is going to be replacing the old item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.Replace(System.Int32,`0)">
|
|
<summary>
|
|
Adds an item to the end of the collection.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index specifying the location of the item to be replaced.
|
|
</param>
|
|
<param name="newItem">
|
|
The item that is going to be replacing the old item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.SetUndoEngineProvider(RSG.Editor.Model.IUndoEngineProvider)">
|
|
<summary>
|
|
Sets the undo engine provider this collection uses to generate undo events on
|
|
collection changes.
|
|
</summary>
|
|
<param name="undoProvider">
|
|
The undo engine provider instance that this collection uses.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.OnCollectionReset">
|
|
<summary>
|
|
Calls the collection changed event handler the describes a Reset change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.OnItemAdded(System.Object,System.Int32)">
|
|
<summary>
|
|
Calls the collection changed event handler that describes a one-item change.
|
|
</summary>
|
|
<param name="item">
|
|
The item that is affected by the change.
|
|
</param>
|
|
<param name="index">
|
|
The zero-based index at which the item was added.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.OnItemMoved(System.Object,System.Int32,System.Int32)">
|
|
<summary>
|
|
Calls the collection changed event handler that describes a one-item Move change.
|
|
</summary>
|
|
<param name="item">
|
|
The item affected by the change.
|
|
</param>
|
|
<param name="newIndex">
|
|
The new index for the changed item.
|
|
</param>
|
|
<param name="oldIndex">
|
|
The old index for the changed item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.OnItemRemoved(System.Object,System.Int32)">
|
|
<summary>
|
|
Calls the collection changed event handler that describes a one-item change.
|
|
</summary>
|
|
<param name="item">
|
|
The item that is affected by the change.
|
|
</param>
|
|
<param name="index">
|
|
The zero-based index at which the item was removed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.OnItemReplaced(System.Object,System.Object,System.Int32)">
|
|
<summary>
|
|
Calls the collection changed event handler that describes a one-item
|
|
Replace change.
|
|
</summary>
|
|
<param name="newItem">
|
|
The new item that is replacing the original item.
|
|
</param>
|
|
<param name="oldItem">
|
|
The original item that is replaced.
|
|
</param>
|
|
<param name="index">
|
|
The zero-based index at which the items was replaced.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.OnItemsAdded(System.Collections.Generic.IEnumerable{`0},System.Int32)">
|
|
<summary>
|
|
Calls the collection changed event handler that describes a multi-item change.
|
|
</summary>
|
|
<param name="items">
|
|
The items that are affected by the change.
|
|
</param>
|
|
<param name="index">
|
|
The zero-based index at which the items was added.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.OnItemsRemoved(System.Collections.Generic.IList{`0},System.Int32)">
|
|
<summary>
|
|
Calls the collection changed event handler that describes a multi-item change.
|
|
</summary>
|
|
<param name="items">
|
|
The items that are affected by the change.
|
|
</param>
|
|
<param name="index">
|
|
The zero-based index at which the items were removed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.ModelCollection`1.OnPropertyChange">
|
|
<summary>
|
|
Calls the property changed event handler that describes a change to the properties.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.PropertyChange`1">
|
|
<summary>
|
|
Implements the <see cref="T:RSG.Editor.Model.IChange"/> interface for a single property
|
|
change.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of property that has changed.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.PropertyChange`1._model">
|
|
<summary>
|
|
The private field used for the <see cref="N:RSG.Editor.Model"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.PropertyChange`1._name">
|
|
<summary>
|
|
The name of the property that changed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.PropertyChange`1._newValue">
|
|
<summary>
|
|
The new value that the property is set to.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.PropertyChange`1._oldValue">
|
|
<summary>
|
|
The old value of the property that changed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.PropertyChange`1.#ctor(`0,`0,System.Object,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.PropertyChange`1"/> class with the
|
|
specified old and new values.
|
|
</summary>
|
|
<param name="oldValue">
|
|
The value of the property before the change.
|
|
</param>
|
|
<param name="newValue">
|
|
The value of the property after the change.
|
|
</param>
|
|
<param name="model">
|
|
The model whose property changed.
|
|
</param>
|
|
<param name="name">
|
|
The name of the property that changed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.PropertyChange`1.Redo">
|
|
<summary>
|
|
Redoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.PropertyChange`1.Undo">
|
|
<summary>
|
|
Undoes this single change.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.PropertyChange`1.SetProperty(`0)">
|
|
<summary>
|
|
Sets the property that this change is associated with to the specified value.
|
|
</summary>
|
|
<param name="value">
|
|
The value to set the property that is associated with this change.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.RedoException">
|
|
<summary>
|
|
The exception that is thrown when a unhandled exception is caught when trying to redo
|
|
a single undo event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.RedoException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.RedoException"/> class using the
|
|
default message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.RedoException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.RedoException"/> class with the
|
|
specified message.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.RedoException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.RedoException"/> class with the
|
|
specified inner exception and the default message.
|
|
</summary>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.RedoException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.RedoException"/> class with the
|
|
specified message and inner exception.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.RedoException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.RedoException"/> class with serialised
|
|
data.
|
|
</summary>
|
|
<param name="info">
|
|
The System.Runtime.Serialization.SerializationInfo that holds the serialised
|
|
object data about the exception being thrown.
|
|
</param>
|
|
<param name="context">
|
|
The System.Runtime.Serialization.StreamingContext that contains contextual
|
|
information about the source or destination.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.UndoEngine">
|
|
<summary>
|
|
Provides undo / redo functionality to the Editor Framework. A instance of this class
|
|
can be past to the <see cref="T:RSG.Editor.Model.ModelBase"/> class to undo / redo
|
|
property changes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._currentEvent">
|
|
<summary>
|
|
A reference to the undo event that is being used to batch events into the same
|
|
command event.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._dirtySuspendedStateCount">
|
|
<summary>
|
|
A count of the number of items this undo engine has been put into a suspended state
|
|
in a row.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._eventSuspendedStateCount">
|
|
<summary>
|
|
A count of the number of items this undo engine has been put into a suspended state
|
|
in a row.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._performingEvent">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.UndoEngine.PerformingEvent"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._redoDirtyCount">
|
|
<summary>
|
|
The count specifying the redo offset since the engine was clean.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._redoStack">
|
|
<summary>
|
|
The private stack containing all of the undo events that have been executed and
|
|
can be redone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._startCommandCount">
|
|
<summary>
|
|
A count of the number of times the <see cref="M:RSG.Editor.Model.UndoEngine.StartBatch"/> method is called
|
|
against the number of times the <see cref="M:RSG.Editor.Model.UndoEngine.FinishBatch"/> method is called. This
|
|
supports hierarchical calls to the <see cref="M:RSG.Editor.Model.UndoEngine.StartBatch"/> and
|
|
<see cref="M:RSG.Editor.Model.UndoEngine.FinishBatch"/> methods.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._undoDirtyCount">
|
|
<summary>
|
|
The count specifying the undo offset since the engine was clean.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine._undoStack">
|
|
<summary>
|
|
The private stack that contains all of the undo events that have occurred
|
|
that are being monitored by this engine.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoEngine"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.Model.UndoEngine.DirtyStateChanged">
|
|
<summary>
|
|
Occurs whenever the dirty state that is being tracked by this undo engine has been
|
|
changed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoEngine.CanRedo">
|
|
<summary>
|
|
Gets a value indicating whether there are any events present that can be redone.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoEngine.CanUndo">
|
|
<summary>
|
|
Gets a value indicating whether there are any undo events present that
|
|
can be undone.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoEngine.DirtyState">
|
|
<summary>
|
|
Gets a value indicating whether this undo engine is currently dirty or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoEngine.PerformingEvent">
|
|
<summary>
|
|
Gets a value indicating whether the engine is currently busy performing
|
|
a undo or redo event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.PushCleanDirtyState">
|
|
<summary>
|
|
Pushes a clean dirty state value into the undo engine. This is used when the
|
|
underlying data has been saved.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.Redo">
|
|
<summary>
|
|
Redoes the action that was last undone by the engine, by popping from the
|
|
redo stack and pushing it to the undo stack.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.ResetAllStacks">
|
|
<summary>
|
|
Clears all of the stacks within this undo engine so no undo or redo event are
|
|
available and the dirty state is set to false.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.Undo">
|
|
<summary>
|
|
Undoes the last added undo event by popping it from the stack and pushing it
|
|
to the redo stack.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.CreateUndoEvent(RSG.Editor.Model.IChange)">
|
|
<summary>
|
|
Creates a new undo event and adds it to the undo stack.
|
|
</summary>
|
|
<param name="change">
|
|
The <see cref="T:RSG.Editor.Model.IChange"/> the describes the undo event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.FinishBatch">
|
|
<summary>
|
|
Finishes the current command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.FinishSuspendedState(RSG.Editor.Model.SuspendUndoEngineMode)">
|
|
<summary>
|
|
Finishes the current suspended state region.
|
|
</summary>
|
|
<param name="mode">
|
|
The mode in which the undo engine was suspended under.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.StartBatch">
|
|
<summary>
|
|
Starts a new command so that all future events are batched into a single undo
|
|
event until the <see cref="M:RSG.Editor.Model.UndoEngine.FinishBatch"/> method is called.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.StartSuspendedState(RSG.Editor.Model.SuspendUndoEngineMode)">
|
|
<summary>
|
|
States a new suspended state region.
|
|
</summary>
|
|
<param name="mode">
|
|
The mode in which the undo engine should be suspended.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.FireDirtyStateChangedEvent">
|
|
<summary>
|
|
Fires the <see cref="E:RSG.Editor.Model.UndoEngine.DirtyStateChanged"/> event for this undo engine.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem">
|
|
<summary>
|
|
A object used to track the dirty state of a undo engine even though suspended
|
|
states.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem._associatedWithEvent">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem.AssociatedWithEvent"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem._isDirty">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem.IsDirty"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem.#ctor(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem"/> class.
|
|
</summary>
|
|
<param name="dirtyState">
|
|
The dirty state for this item to track.
|
|
</param>
|
|
<param name="associatedWithEvent">
|
|
A value indicating whether this track item was produced with an event.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem.AssociatedWithEvent">
|
|
<summary>
|
|
Gets a value indicating whether this track item is directly linked with an
|
|
event in the undo engine or whether this was created during a suspended state
|
|
frame.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoEngine.DirtyValueTrackItem.IsDirty">
|
|
<summary>
|
|
Gets a value indicating whether the dirty state of this track item is set or
|
|
not..
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.UndoEvent">
|
|
<summary>
|
|
Represents a single event inside the undo / redo system can be undone that can be used
|
|
by a instance of the <see cref="T:RSG.Editor.Model.UndoEngine"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoEvent._changes">
|
|
<summary>
|
|
The private list of the changes that have occurred within this undo event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEvent.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoEvent"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoEvent.ChangeCount">
|
|
<summary>
|
|
Gets the number of changes that this event currently has in it.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEvent.AddChange(RSG.Editor.Model.IChange)">
|
|
<summary>
|
|
Adds the specified change to this undo event.
|
|
</summary>
|
|
<param name="change">
|
|
The single change that should be added to this undo event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEvent.Redo">
|
|
<summary>
|
|
Redoes this undo event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoEvent.Undo">
|
|
<summary>
|
|
Undoes this undo event.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.UndoException">
|
|
<summary>
|
|
The exception that is thrown when a unhandled exception is caught when trying to undo
|
|
a single undo event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoException"/> class using the
|
|
default message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoException"/> class with the
|
|
specified message.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoException"/> class with the
|
|
specified inner exception and the default message.
|
|
</summary>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoException"/> class with the
|
|
specified message and inner exception.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoException"/> class with serialised
|
|
data.
|
|
</summary>
|
|
<param name="info">
|
|
The System.Runtime.Serialization.SerializationInfo that holds the serialised
|
|
object data about the exception being thrown.
|
|
</param>
|
|
<param name="context">
|
|
The System.Runtime.Serialization.StreamingContext that contains contextual
|
|
information about the source or destination.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.Model.UndoRedoBatch">
|
|
<summary>
|
|
Provides functionality so that multiple changes can be grouped together to form a
|
|
single undo event.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoRedoBatch._disposed">
|
|
<summary>
|
|
The private event handler that is used for the <see cref="E:RSG.Editor.Model.UndoRedoBatch.Disposed"/> event.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoRedoBatch._disposing">
|
|
<summary>
|
|
The private event handler that is used for the <see cref="E:RSG.Editor.Model.UndoRedoBatch.Disposing"/> event.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoRedoBatch._engine">
|
|
<summary>
|
|
Gets the <see cref="T:RSG.Editor.Model.UndoEngine"/> instance that this batch was
|
|
created for.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Model.UndoRedoBatch._isDisposed">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.Model.UndoRedoBatch.IsDisposed"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoRedoBatch.#ctor(RSG.Editor.Model.UndoEngine)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.Model.UndoRedoBatch"/> class.
|
|
</summary>
|
|
<param name="engine">
|
|
A instance of the <see cref="T:RSG.Editor.Model.UndoEngine"/> that this batch of
|
|
changes will be added to as a single undo event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoRedoBatch.Finalize">
|
|
<summary>
|
|
Finalises an instance of the <see cref="T:RSG.Editor.Model.UndoRedoBatch"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.Model.UndoRedoBatch.Disposed">
|
|
<summary>
|
|
Occurs when this instance has been disposed by the garage collector or by a user.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.Model.UndoRedoBatch.Disposing">
|
|
<summary>
|
|
Occurs when this instance is being disposed by the garage collector or by a user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Model.UndoRedoBatch.IsDisposed">
|
|
<summary>
|
|
Gets a value indicating whether this instance has been disposed of.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoRedoBatch.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or
|
|
resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoRedoBatch.Dispose(System.Boolean)">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or
|
|
resetting unmanaged resources.
|
|
</summary>
|
|
<param name="disposeManaged">
|
|
If true the managed resources for this instance also get disposed of as well as
|
|
the unmanaged resources.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoRedoBatch.DisposeManagedResources">
|
|
<summary>
|
|
When overridden disposes of the managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Model.UndoRedoBatch.ThrowIfDisposed">
|
|
<summary>
|
|
Throws a System.ObjectDisposedException exception if this instance has been
|
|
already disposed of.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ButtonCommand">
|
|
<summary>
|
|
Provides the ability to define a rockstar command as a button command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ButtonCommand._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ButtonCommand.Command"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ButtonCommand.#ctor(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ButtonCommand"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The <see cref="T:RSG.Editor.RockstarRoutedCommand"/> that this definition is
|
|
representing.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ButtonCommand.Command">
|
|
<summary>
|
|
Gets the <see cref="T:RSG.Editor.RockstarRoutedCommand"/> that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ButtonCommand.CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ButtonCommand.RSG#Editor#ICommandWithParameter#CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CanExecuteCommandData">
|
|
<summary>
|
|
Provides data to a predicate method which determines whether a associated command can
|
|
be executed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CanExecuteCommandData._continueRouting">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CanExecuteCommandData.ContinueRouting"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CanExecuteCommandData._handled">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CanExecuteCommandData.Handled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CanExecuteCommandData.#ctor(System.Windows.Input.ICommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CanExecuteCommandData"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command associated with this data.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CanExecuteCommandData.ContinueRouting">
|
|
<summary>
|
|
Gets or sets a value indicating whether the input routed event that invoked the
|
|
command should continue to route through the element tree.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CanExecuteCommandData.Handled">
|
|
<summary>
|
|
Gets or sets a value indicating whether the routed event has been handled somewhere
|
|
as it travels the element tree.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CanExecuteCommandData`1">
|
|
<summary>
|
|
Provides data to a predicate method which determines whether a associated command can
|
|
be executed based on a parameter of the specified type.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter used to determine whether the associated command can be
|
|
executed.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.CanExecuteCommandData`1._originalParameterWasNull">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CanExecuteCommandData`1.OriginalParameterWasNull"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CanExecuteCommandData`1._parameter">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CanExecuteCommandData`1.Parameter"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CanExecuteCommandData`1.#ctor(System.Windows.Input.ICommand,`0)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CanExecuteCommandData`1"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command associated with this data.
|
|
</param>
|
|
<param name="parameter">
|
|
The parameter that the predicate method can use to determine whether the command
|
|
can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CanExecuteCommandData`1.OriginalParameterWasNull">
|
|
<summary>
|
|
Gets a value indicating whether the parameter passed in from the source event data
|
|
was set to null or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CanExecuteCommandData`1.Parameter">
|
|
<summary>
|
|
Gets the parameter that was associated with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CanExecuteCommandException">
|
|
<summary>
|
|
Represents errors that occur during a predicate method determining whether a command
|
|
can be executed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CanExecuteCommandException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CanExecuteCommandException"/> class
|
|
using the default
|
|
message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CanExecuteCommandException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CanExecuteCommandException"/> class
|
|
with the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CanExecuteCommandException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CanExecuteCommandException"/> class
|
|
with the specified inner exception and the default message.
|
|
</summary>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CanExecuteCommandException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CanExecuteCommandException"/> class
|
|
with the specified message and inner exception.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CanExecuteCommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CanExecuteCommandException"/> class
|
|
with serialised data.
|
|
</summary>
|
|
<param name="info">
|
|
The System.Runtime.Serialization.SerializationInfo that holds the serialised
|
|
object data about the exception being thrown.
|
|
</param>
|
|
<param name="context">
|
|
The System.Runtime.Serialization.StreamingContext that contains contextual
|
|
information about the source or destination.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CanExecuteCommandDelegate">
|
|
<summary>
|
|
Represents the predicate method that determines whether a command can be executed.
|
|
</summary>
|
|
<param name="e">
|
|
The object containing the data to use inside the predicate method to determine whether
|
|
the command can be executed.
|
|
</param>
|
|
<returns>
|
|
A value indicating whether the command associated with the specified data can be
|
|
executed.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.CanExecuteCommandDelegate`1">
|
|
<summary>
|
|
Represents the predicate method that determines whether a command can be executed.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the command parameter contained within the specified data.
|
|
</typeparam>
|
|
<param name="e">
|
|
The object containing the data to use inside the predicate method to determine whether
|
|
the command can be executed.
|
|
</param>
|
|
<returns>
|
|
A value indicating whether the command associated with the specified data can be
|
|
executed.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ChildMenu">
|
|
<summary>
|
|
Represents a menu that is positioned inside another menu. This class cannot be
|
|
inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ChildMenu.#ctor(System.UInt16,System.Boolean,System.String,System.Guid,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ChildMenu"/> class.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="startsGroup">
|
|
A value indicating whether this command bar item should start a new group. (I.e.
|
|
Placed directly after a separator).
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.ComboCommand">
|
|
<summary>
|
|
Provides a base class to a definition of a combo command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboCommand.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ComboCommand"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ComboCommand.CanItemsBeSelected">
|
|
<summary>
|
|
Gets a value indicating whether the individual items are selectable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ComboCommand.SelectionMode">
|
|
<summary>
|
|
Gets a value indicating the selection mode style adopted by this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ComboItemsCollection">
|
|
<summary>
|
|
The collection that is used for the combo items collection inside a
|
|
<see cref="T:RSG.Editor.CommandBarItemViewModel"/> object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ComboItemsCollection._parent">
|
|
<summary>
|
|
The parent view model for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboItemsCollection.#ctor(System.Collections.IEnumerable,RSG.Editor.CommandBarItemViewModel)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ComboItemsCollection"/> class.
|
|
</summary>
|
|
<param name="source">
|
|
The iterator around the source items for this collection.
|
|
</param>
|
|
<param name="parent">
|
|
The parent view model.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboItemsCollection.ConvertItem(RSG.Editor.IMultiCommandItem)">
|
|
<summary>
|
|
Converts the single specified source item to the target type.
|
|
</summary>
|
|
<param name="item">
|
|
The item to convert.
|
|
</param>
|
|
<returns>
|
|
A new item of the target type converted from the specified source item.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ComboItemsCollection.HandleCollectionChange">
|
|
<summary>
|
|
Gets called whenever the collection changes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandBarItem">
|
|
<summary>
|
|
Provides a abstract base class to all of the objects that will be placed within the
|
|
command bar hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._areMultiItemsShown">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.AreMultiItemsShown"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._eachItemStartsGroup">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.EachItemStartsGroup"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._id">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.Id"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._isVisible">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.IsVisible"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._parentId">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.ParentId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._priority">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.Priority"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._showFilterCount">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.ShowFilterCount"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._startsGroup">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.StartsGroup"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._text">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.Text"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItem._width">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItem.Width"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItem.#ctor(System.UInt16,System.Boolean,System.String,System.Guid,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandBarItem"/> class.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="startsGroup">
|
|
A value indicating whether this command bar item should start a new group. (I.e.
|
|
Placed directly after a separator).
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.AreMultiItemsShown">
|
|
<summary>
|
|
Gets or sets a value indicating whether the individual items are shown to the user
|
|
for this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.EachItemStartsGroup">
|
|
<summary>
|
|
Gets or sets a value indicating whether the individual items start a group each or
|
|
not. Only applicable when instancing a multi command with
|
|
<see cref="P:RSG.Editor.CommandBarItem.AreMultiItemsShown"/> set to true.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.Id">
|
|
<summary>
|
|
Gets or sets the global unique identifier that is used to reference this item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.IsVisible">
|
|
<summary>
|
|
Gets or sets a value indicating whether this command bar item is visible to the
|
|
user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.ParentId">
|
|
<summary>
|
|
Gets or sets the global identifier for the parent of this item inside the command
|
|
bar hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.Priority">
|
|
<summary>
|
|
Gets or sets the priority of the item which indicates the position of it relative
|
|
to the other items under the same parent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.ShowFilterCount">
|
|
<summary>
|
|
Gets or sets a value indicating whether the filter check count is shown to the
|
|
user in the user interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.StartsGroup">
|
|
<summary>
|
|
Gets or sets a value indicating whether this item is proceeded by a separator to
|
|
indicate the start of a new group inside the command bar hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.Text">
|
|
<summary>
|
|
Gets or sets the text for this command bar item. This appears on the menu item in
|
|
the hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItem.Width">
|
|
<summary>
|
|
Gets or sets the width of the control used for this command instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandBarItemViewModel">
|
|
<summary>
|
|
Defines the view model for a <see cref="T:RSG.Editor.CommandBarItem"/> object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._emptyCommand">
|
|
<summary>
|
|
A routed command that is used in the case of a missing definition. Using
|
|
this command makes sure the command will not be implemented anyway and be
|
|
shown as disabled.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._syncRoot">
|
|
<summary>
|
|
A generic object that provides synchronisation between multiple threads while
|
|
creating and altering view models.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._creationCache">
|
|
<summary>
|
|
A cache that contains the created view models indexed by the parent identifier.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._delayedPriorityChanges">
|
|
<summary>
|
|
The private collections containing the identifiers to the parents whose children
|
|
have had a priority change during a delayed point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._resettingItems">
|
|
<summary>
|
|
A value indicating whether items inside a collection view model are currently
|
|
being reset.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._unresolvedDefinitions">
|
|
<summary>
|
|
A value indicating whether there exists any view models that have an unresolved
|
|
definition in them.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._comboItems">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItemViewModel.ComboItems"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._commandBarItem">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItemViewModel.CommandBarItem"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._commandDefinition">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItemViewModel.CommandDefinition"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._displayType">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItemViewModel.DisplayType"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel._dynamicChildren">
|
|
<summary>
|
|
The private collection containing the children that represent the items inside the
|
|
dynamic menu. This is due to the dynamic menu having to create the children on the
|
|
fly without needing to embed them in a pre-existing list and the items don't
|
|
reference the parent by id.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.#cctor">
|
|
<summary>
|
|
Initialises static members of the <see cref="T:RSG.Editor.CommandBarItemViewModel"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.#ctor(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandBarItemViewModel"/> class to
|
|
represent the specified command bar item.
|
|
</summary>
|
|
<param name="item">
|
|
The command bar item that this view model will be representing.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.#ctor(RSG.Editor.IMultiCommandItem,RSG.Editor.CommandInstance)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandBarItemViewModel"/> class to
|
|
represent the specified definition item.
|
|
</summary>
|
|
<param name="item">
|
|
The multi item that this view model is being created for.
|
|
</param>
|
|
<param name="instance">
|
|
The original command instance that is being broken into multiple items.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.#ctor(RSG.Editor.IDynamicMenuItem)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandBarItemViewModel"/> class with
|
|
a dynamic item.
|
|
</summary>
|
|
<param name="dynamicItem">
|
|
The item that is used to describe the command bar item and command definition.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.Band">
|
|
<summary>
|
|
Gets or sets a value that indicates where the toolbar should be located in the
|
|
ToolBarTray.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.BandIndex">
|
|
<summary>
|
|
Gets or sets the band index number that indicates the position of the toolbar on
|
|
the band.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.Children">
|
|
<summary>
|
|
Gets the collection of child command view models of this view model.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.ComboItems">
|
|
<summary>
|
|
Gets the items that can be used for a combo control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.Command">
|
|
<summary>
|
|
Gets the command that the associated definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.CommandBarItem">
|
|
<summary>
|
|
Gets the command bar item that is the part of the associated data for this view
|
|
model.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.CommandDefinition">
|
|
<summary>
|
|
Gets the command definition that is the part of the associated data for this view
|
|
model.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.DisplayStyle">
|
|
<summary>
|
|
Gets or sets a value that can be used to change how the control that is used to
|
|
display this item gets styled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.DisplayType">
|
|
<summary>
|
|
Gets the display type for this command bar item view model which specifies how the
|
|
command should be rendered in the command hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.DynamicChildren">
|
|
<summary>
|
|
Gets the read-only collection containing the dynamic menu child items.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.FilterCount">
|
|
<summary>
|
|
Gets the filter count string to show for a filter command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.Icon">
|
|
<summary>
|
|
Gets the System.Windows.Media.Imaging.BitmapSource object that represents the
|
|
command icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.IsEnabled">
|
|
<summary>
|
|
Gets a value indicating whether this command bar item is currently enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether the command definition is currently in the
|
|
toggled state or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.KeyGestureText">
|
|
<summary>
|
|
Gets the text that contains the key gesture that is attached to this command bar
|
|
item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.Scopes">
|
|
<summary>
|
|
Gets the collection defining the different scopes for the command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.SearchParameters">
|
|
<summary>
|
|
Gets the search parameters from the command definition if a conversion is possible;
|
|
otherwise, returns null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.SelectedItem">
|
|
<summary>
|
|
Gets or sets the item that is currently selected in the combo control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.StartsGroup">
|
|
<summary>
|
|
Gets or sets a value indicating whether this command item starts a new group.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.ShowFilterCount">
|
|
<summary>
|
|
Gets or sets a value indicating whether the filter check count is shown to the
|
|
user in the user interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.Text">
|
|
<summary>
|
|
Gets or sets the text that appears with this command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.ToolTip">
|
|
<summary>
|
|
Gets the tooltip that will be shown for this command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.IsVisible">
|
|
<summary>
|
|
Gets or sets a value indicating whether this command bar item is visible to the
|
|
user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.Width">
|
|
<summary>
|
|
Gets the width of the control attached to this view model.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.Create(System.Guid)">
|
|
<summary>
|
|
Retrieves a collection of view models that wrap command bar items whose parent id
|
|
property equals the specified id.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier of the parent whose items should have their corresponding view
|
|
models retrieved.
|
|
</param>
|
|
<returns>
|
|
A collection of view models that wrap command bar items whose parent id property
|
|
equals the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.CommitPriorityChanges">
|
|
<summary>
|
|
Commits the currently delayed priority changes by resetting the necessary
|
|
collections.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.OnDefinitionAdded(RSG.Editor.CommandDefinition)">
|
|
<summary>
|
|
Called whenever a command definition is added to the command manager.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition that has been added to the command manager.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.OnItemAdded(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Called whenever a item is added to the command manager.
|
|
</summary>
|
|
<param name="addedItem">
|
|
The item that has been added to the command manager.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.OnItemRemoved(RSG.Editor.CommandBarItem,System.Boolean)">
|
|
<summary>
|
|
Called whenever a item is removed from the command manager.
|
|
</summary>
|
|
<param name="removedItem">
|
|
The item that has been removed from to the command manager.
|
|
</param>
|
|
<param name="sendEvent">
|
|
A value indicating whether the property changed event is fired for the
|
|
<see cref="P:RSG.Editor.CommandBarItemViewModel.IsEnabled"/> property.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.OnChildrenChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
|
|
<summary>
|
|
Called whenever a change is made to one of the child collections.
|
|
</summary>
|
|
<param name="s">
|
|
The collection that has changed.
|
|
</param>
|
|
<param name="e">
|
|
The System.Collections.Specialized.NotifyCollectionChangedEventArgs data for the
|
|
event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.OnPriorityChanged(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Called whenever the priority value on a command bar item has been changed.
|
|
</summary>
|
|
<param name="item">
|
|
The item that has had its priority value changed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.OnStartsGroupChanged(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Called whenever the start group flag on a command bar item has been changed.
|
|
</summary>
|
|
<param name="item">
|
|
The item that has had its starts group flag changed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.ResetItems(System.Guid)">
|
|
<summary>
|
|
Resets the collection for the parent with the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier of the parent whose collection needs to be reset.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.InitialiseDynamicMenu">
|
|
<summary>
|
|
Initialises a dynamic menu item by binding this view models children with the items
|
|
on the dynamic menu.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.ResolveDefinition(RSG.Editor.CommandDefinition)">
|
|
<summary>
|
|
Called whenever a new command definition is added to the command
|
|
manager in-case this view model has a unresolved command definition.
|
|
</summary>
|
|
<param name="definition">
|
|
The command definition that has been added to the command manager.
|
|
</param>
|
|
<returns>
|
|
A value indicating whether the definition is now resolved.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.SourcePropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Gets called whenever a property changed event occurs from the associated command
|
|
bar item or the associated command definition.
|
|
</summary>
|
|
<param name="sender">
|
|
The command bar item that fired the event.
|
|
</param>
|
|
<param name="e">
|
|
The event data including the name of the property that changed.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandBarItemViewModel.DynamicMenuChildren">
|
|
<summary>
|
|
Represents the collection of command bar item view model objects that are kept in
|
|
sync with a collection of dynamic menu items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.DynamicMenuChildren.#ctor(System.Collections.ObjectModel.ObservableCollection{RSG.Editor.IDynamicMenuItem})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandBarItemViewModel.DynamicMenuChildren"/> class.
|
|
</summary>
|
|
<param name="source">
|
|
The source items for this collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.DynamicMenuChildren.ConvertItem(RSG.Editor.IDynamicMenuItem)">
|
|
<summary>
|
|
Creates a command bar item view model from the specified multi command item.
|
|
</summary>
|
|
<param name="item">
|
|
The multi command item object to use to construct the new view model.
|
|
</param>
|
|
<returns>
|
|
A new command bar item view model constructed from the specified item.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandBarItemViewModel.DynamicCommandInstance">
|
|
<summary>
|
|
The command instance that is created to represent a dynamic menu command item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModel.DynamicCommandInstance._commandParameter">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItemViewModel.DynamicCommandInstance.CommandParameter"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModel.DynamicCommandInstance.#ctor(RSG.Editor.RockstarRoutedCommand,System.String,System.Object)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandBarItemViewModel.DynamicCommandInstance"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command that this command bar item is instancing.
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="commandParameter">
|
|
The command parameter that should be sent through the UI element to the
|
|
execution logic.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModel.DynamicCommandInstance.CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandBarItemViewModelCollection">
|
|
<summary>
|
|
Represents a collection of <see cref="T:RSG.Editor.CommandBarItemViewModel"/> objects
|
|
that produces notification events when manipulated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModelCollection._id">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItemViewModelCollection.Id"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModelCollection._invisibleItems">
|
|
<summary>
|
|
A private list of all of the invisible items currently associated with this
|
|
collection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModelCollection._isSealed">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandBarItemViewModelCollection.IsSealed"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandBarItemViewModelCollection._multiCommands">
|
|
<summary>
|
|
A private list containing all multi item command objects that have been added to
|
|
this collection, as well as their indices into this collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.#ctor(System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandBarItemViewModelCollection"/>
|
|
class as a wrapper for the list specified by its parent id.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier of the parent whose children are contained within this collection.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModelCollection.Id">
|
|
<summary>
|
|
Gets the identifier of the parent whose children are contained within this
|
|
collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandBarItemViewModelCollection.IsSealed">
|
|
<summary>
|
|
Gets a value indicating whether this collection is currently sealed from
|
|
modifications.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.GetIndexAfter(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Determines the index after the specified item in the collection. This is to support
|
|
multi items currently expanded with in the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in the collection.
|
|
</param>
|
|
<returns>
|
|
The index after the specified item if found in the list; otherwise, the last index
|
|
in the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.IndexOf(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Determines the index of a specific item in the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in the collection.
|
|
</param>
|
|
<returns>
|
|
The index of item if found in the list; otherwise, -1.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.Seal">
|
|
<summary>
|
|
Sets the <see cref="P:RSG.Editor.CommandBarItemViewModelCollection.IsSealed"/> property to true so that exceptions will be fired
|
|
if someone tries to manipulate the items within the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.AddSeparator(System.Int32)">
|
|
<summary>
|
|
Adds a new separator item located at the specified index. If there is already a
|
|
separator that or next to the specified index, nothing happens.
|
|
</summary>
|
|
<param name="index">
|
|
The index the new separator should be located at.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.Insert(System.Int32,RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Inserts the specified item into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index at which the specified item should be inserted.
|
|
</param>
|
|
<param name="item">
|
|
The object to insert into the collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.Remove(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Removes the first occurrence of a specific object from the collection.
|
|
</summary>
|
|
<param name="item">
|
|
The object to remove from the collection.
|
|
</param>
|
|
<returns>
|
|
True if item was successfully removed from the collection, otherwise, false. This
|
|
method also returns false if item is not found in the original collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.RemoveSeparator(System.Int32)">
|
|
<summary>
|
|
Removed the separator item that is located at the specified index. If the item at
|
|
the specified index isn't a separator nothing happens.
|
|
</summary>
|
|
<param name="index">
|
|
The index of the separator to remove.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.ResetItems(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Removes all items from the collection and re adds them from the rockstar command
|
|
manager.
|
|
</summary>
|
|
<param name="clearCache">
|
|
A value indicating whether the cache of multi commands and invisible items should
|
|
also be cleared.
|
|
</param>
|
|
<param name="sortPriorities">
|
|
A value indicating whether the priorities for the items should be set in numerical
|
|
order.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.Unseal">
|
|
<summary>
|
|
Sets the <see cref="P:RSG.Editor.CommandBarItemViewModelCollection.IsSealed"/> property to false so that you can manipulate the
|
|
items within the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.ClearItems">
|
|
<summary>
|
|
Removes all items from the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.InsertItem(System.Int32,RSG.Editor.CommandBarItemViewModel)">
|
|
<summary>
|
|
Inserts an item into the collection at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index at which <paramref name="item" /> should be inserted.
|
|
</param>
|
|
<param name="item">
|
|
The object to insert.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.MoveItem(System.Int32,System.Int32)">
|
|
<summary>
|
|
Moves the item at the specified index to a new location in the collection.
|
|
</summary>
|
|
<param name="oldIndex">
|
|
The zero-based index specifying the location of the item to be moved.
|
|
</param>
|
|
<param name="newIndex">
|
|
The zero-based index specifying the new location of the item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.RemoveItem(System.Int32)">
|
|
<summary>
|
|
Removes the item at the specified index of the collection.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the element to remove.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.SetItem(System.Int32,RSG.Editor.CommandBarItemViewModel)">
|
|
<summary>
|
|
Replaces the element at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the element to replace.
|
|
</param>
|
|
<param name="item">
|
|
The new value for the element at the specified index.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.CheckSealedFlagBeforeModifying">
|
|
<summary>
|
|
Throws a exception if the <see cref="P:RSG.Editor.CommandBarItemViewModelCollection.IsSealed"/> flag is set to true.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.IndexToPlaceItem(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Gets the index that the specified item should be inserted within this collection.
|
|
If this collection already contains the specified item -1 is returned.
|
|
</summary>
|
|
<param name="item">
|
|
The item whose insertion index should be returned.
|
|
</param>
|
|
<returns>
|
|
The index that the specified item should be inserted within this collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.OnEachItemStartsGroupChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Gets called whenever the value indicating whether a instance shows its multi items
|
|
with separators or not changes.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs data used for the event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.OnIsVisibleChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Gets called whenever the value indicating whether a instance is shown to user or
|
|
not changes.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs data used for the event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.OnMultiItemsAdded(System.Collections.Generic.List{RSG.Editor.CommandInstance},System.Collections.IList,System.Int32)">
|
|
<summary>
|
|
Called whenever items are added to a multi command items collection.
|
|
</summary>
|
|
<param name="instances">
|
|
The list of instances of the multi command that have been affected.
|
|
</param>
|
|
<param name="newItems">
|
|
The list containing the items that have been added to the multi command.
|
|
</param>
|
|
<param name="startingIndex">
|
|
The index of the first new item in the multi command items.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.OnMultiItemsChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
|
|
<summary>
|
|
Gets called whenever the items collection is changed.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.CollectionChangeEventArgs data for the event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.OnMultiItemsMoved(System.Collections.Generic.List{RSG.Editor.CommandInstance},System.Int32,System.Int32)">
|
|
<summary>
|
|
Called whenever items are moved inside a multi command items collection.
|
|
</summary>
|
|
<param name="instances">
|
|
The list of instances of the multi command that have been affected.
|
|
</param>
|
|
<param name="oldIndex">
|
|
The index of the item before it was moved.
|
|
</param>
|
|
<param name="newIndex">
|
|
The new index of the item moved.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.OnMultiItemsRemoved(System.Collections.Generic.List{RSG.Editor.CommandInstance},System.Int32,System.Int32)">
|
|
<summary>
|
|
Called whenever items are removed to a multi command items collection.
|
|
</summary>
|
|
<param name="instances">
|
|
The list of instances of the multi command that have been affected.
|
|
</param>
|
|
<param name="count">
|
|
The number of items that have been removed. A negative number represents all of the
|
|
items from the specified index.
|
|
</param>
|
|
<param name="startingIndex">
|
|
The index of the first old item in the multi command items.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.OnMultiItemsReplaced(System.Collections.Generic.List{RSG.Editor.CommandInstance},System.Collections.IList,System.Int32)">
|
|
<summary>
|
|
Called whenever items are replaced inside a multi command items collection.
|
|
</summary>
|
|
<param name="instances">
|
|
The list of instances of the multi command that have been affected.
|
|
</param>
|
|
<param name="items">
|
|
The list containing the items that have replaced the items located at the specified
|
|
starting index.
|
|
</param>
|
|
<param name="startingIndex">
|
|
The index of the replaced item in the multi command items.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandBarItemViewModelCollection.OnShowMultiItemsChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Gets called whenever the value indicating whether a instance shows its multi items
|
|
or not changes.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs data used for the event.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandDefinition">
|
|
<summary>
|
|
Provides a base class to all of the command definitions that wrap a command object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandDefinition._ignoreNextExecution">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandDefinition.IgnoreNextExecution"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandDefinition._isEnabled">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandDefinition.IsEnabled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandDefinition.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandDefinition"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.CategoryName">
|
|
<summary>
|
|
Gets the command category name this definition belongs to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.Command">
|
|
<summary>
|
|
Gets the <see cref="T:RSG.Editor.RockstarRoutedCommand"/> that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.Description">
|
|
<summary>
|
|
Gets the description for this command. This is also what is shown as a tooltip
|
|
along with the key gesture if one is set.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.Icon">
|
|
<summary>
|
|
Gets the System.Windows.Media.Imaging.BitmapSource object that represents the icon
|
|
that is used for this command, this can be null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.IgnoreNextExecution">
|
|
<summary>
|
|
Gets or sets a value indicating whether the command that this class is defining
|
|
should have its next execution ignored.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.IsEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether the instances for this command definition
|
|
which be enabled or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.KeyGesture">
|
|
<summary>
|
|
Gets or sets the System.Windows.Input.KeyGesture object that is associated with
|
|
this command definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.KeyGestureCount">
|
|
<summary>
|
|
Gets the number of key gestures currently associated with this command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.Name">
|
|
<summary>
|
|
Gets the name of this command definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.KeyGestures">
|
|
<summary>
|
|
Gets a iterator around all of the key gestures that are associated with this
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandDefinition.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the key gesture within the commands gesture collection at the
|
|
specified zero-based index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index for the gesture to get or set.
|
|
</param>
|
|
<returns>
|
|
The key gesture within the commands gesture collection at the specified zero-based
|
|
index.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandDefinition.AddKeyGesture(System.Windows.Input.KeyGesture)">
|
|
<summary>
|
|
Adds the specified key gesture to the commands collection of associated gestures.
|
|
</summary>
|
|
<param name="gesture">
|
|
The gesture to add to the command.
|
|
</param>
|
|
<returns>
|
|
The zero-based index into the commands gesture collection where the command was
|
|
added if it was added successfully; otherwise, -1.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandDefinition.DeserialiseState(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Deserialises the commands state using the data contained within the specified xml
|
|
reader.
|
|
</summary>
|
|
<param name="reader">
|
|
The xml reader that contains the state data.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
<returns>
|
|
A value indicating whether the command needs to be executed due to the
|
|
de-serialisation process.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandDefinition.RemoveKeyGesture(System.Int32)">
|
|
<summary>
|
|
Removes the commands key gesture located at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index to the key gesture to remove.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandDefinition.ReplaceKeyGesture(System.Windows.Input.KeyGesture,System.Windows.Input.KeyGesture)">
|
|
<summary>
|
|
Replaces the first occurrence of the specified old gesture with the specified new
|
|
gesture.
|
|
</summary>
|
|
<param name="oldGesture">
|
|
The old gesture that will be replaced by the specified new gesture.
|
|
</param>
|
|
<param name="newGesture">
|
|
The new gesture to replace the old gesture with.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandDefinition.SerialiseState(System.Xml.XmlWriter,System.IFormatProvider)">
|
|
<summary>
|
|
Serialises the state of this definition into the specified xml writer.
|
|
</summary>
|
|
<param name="writer">
|
|
The xml writer that the state gets serialised out to.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.ModifiedTimeChangedEventArgs">
|
|
<summary>
|
|
Provides data for a event that is representing a last write time change to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModifiedTimeChangedEventArgs._fullPath">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ModifiedTimeChangedEventArgs.FullPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ModifiedTimeChangedEventArgs.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ModifiedTimeChangedEventArgs"/> class.
|
|
</summary>
|
|
<param name="fullpath">
|
|
The full path to the file whose read-only state has changed.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ModifiedTimeChangedEventArgs.FullPath">
|
|
<summary>
|
|
Gets the full path to the file whose read-only state has changed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.MruCommandActionAsync`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a MRU button
|
|
command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter pass into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandActionAsync`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.MruCommandActionAsync`1"/>
|
|
class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandActionAsync`1.CanExecute(`0,System.String,System.String[])">
|
|
<summary>
|
|
Override to set logic against the can execute command handler. By default this
|
|
returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="path">
|
|
The path sent with the MRU command.
|
|
</param>
|
|
<param name="additional">
|
|
The additional information for the path property sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandActionAsync`1.Execute(`0,System.String,System.String[])">
|
|
<summary>
|
|
Override to set logic against the execute command handler.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="path">
|
|
The path sent with the MRU command.
|
|
</param>
|
|
<param name="additional">
|
|
The additional information for the path property sent with the command.
|
|
</param>
|
|
<returns>
|
|
A task that represents the work done by the command handler.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandActionAsync`1.CanExecute(`0,RSG.Editor.MultiCommandParameter{System.Tuple{System.String,System.String[]}})">
|
|
<summary>
|
|
Override to set logic against the can execute command handler. By default this
|
|
returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="parameter">
|
|
The secondary command parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandActionAsync`1.Execute(`0,RSG.Editor.MultiCommandParameter{System.Tuple{System.String,System.String[]}})">
|
|
<summary>
|
|
Override to set logic against the execute command handler.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="parameter">
|
|
The secondary command parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
A task that represents the work done by the command handler.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.MruCommandAction`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a MRU button
|
|
command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter pass into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandAction`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.MruCommandAction`1"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandAction`1.CanExecute(`0,System.String,System.String[])">
|
|
<summary>
|
|
Override to set logic against the can execute command handler. By default this
|
|
returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="path">
|
|
The path sent with the MRU command.
|
|
</param>
|
|
<param name="additional">
|
|
The additional information for the path property sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandAction`1.Execute(`0,System.String,System.String[])">
|
|
<summary>
|
|
Override to set logic against the execute command handler.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="path">
|
|
The path sent with the MRU command.
|
|
</param>
|
|
<param name="additional">
|
|
The additional information for the path property sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandAction`1.CanExecute(`0,RSG.Editor.MultiCommandParameter{System.Tuple{System.String,System.String[]}})">
|
|
<summary>
|
|
Override to set logic against the can execute command handler. By default this
|
|
returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="parameter">
|
|
The secondary command parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.MruCommandAction`1.Execute(`0,RSG.Editor.MultiCommandParameter{System.Tuple{System.String,System.String[]}})">
|
|
<summary>
|
|
Override to set logic against the execute command handler.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="parameter">
|
|
The secondary command parameter that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.ParameterResolverDelegate`1">
|
|
<summary>
|
|
Represents the method that is used to retrieve a command parameter object of the
|
|
specified type for the specified command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the retrieved parameter.
|
|
</typeparam>
|
|
<param name="commandData">
|
|
The data that was sent with the command containing among other things the command
|
|
whose command parameter needs to be resolved.
|
|
</param>
|
|
<returns>
|
|
The command parameter object of the specified type for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.PerforceFileSpec">
|
|
<summary>
|
|
Contains a perforce file specification that can be represented as either a
|
|
client, depot or local path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileSpec._clientPath">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Editor.PerforceFileSpec.ClientPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileSpec._depotPath">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Editor.PerforceFileSpec.DepotPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileSpec._localPath">
|
|
<summary>
|
|
Private field for the <see cref="P:RSG.Editor.PerforceFileSpec.LocalPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.PerforceFileSpec.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.PerforceFileSpec"/> class using
|
|
the specified client, depot and local paths.
|
|
</summary>
|
|
<param name="clientPath"></param>
|
|
<param name="depotPath"></param>
|
|
<param name="localPath"></param>
|
|
</member>
|
|
<member name="P:RSG.Editor.PerforceFileSpec.ClientPath">
|
|
<summary>
|
|
Gets the value that represents the files client path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.PerforceFileSpec.DepotPath">
|
|
<summary>
|
|
Gets the value that represents the files perforce depot path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.PerforceFileSpec.LocalPath">
|
|
<summary>
|
|
Gets the value that represents the files local path.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.PerforceFileSpec.ClientSpecList(System.String[])">
|
|
<summary>
|
|
Creates a list of <see cref="T:RSG.Editor.PerforceFileSpec"/> objects from a list of
|
|
client paths.
|
|
</summary>
|
|
<param name="paths"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.PerforceFileSpec.ClientSpecList(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Creates a list of <see cref="T:RSG.Editor.PerforceFileSpec"/> objects from a list of
|
|
client paths.
|
|
</summary>
|
|
<param name="paths"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.PerforceFileSpec.DepotSpecList(System.String[])">
|
|
<summary>
|
|
Creates a list of <see cref="T:RSG.Editor.PerforceFileSpec"/> objects from a list of
|
|
depot paths.
|
|
</summary>
|
|
<param name="paths"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.PerforceFileSpec.DepotSpecList(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Creates a list of <see cref="T:RSG.Editor.PerforceFileSpec"/> objects from a list of
|
|
depot paths.
|
|
</summary>
|
|
<param name="paths"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.PerforceFileSpec.LocalSpecList(System.String[])">
|
|
<summary>
|
|
Creates a list of <see cref="T:RSG.Editor.PerforceFileSpec"/> objects from a list of
|
|
local paths.
|
|
</summary>
|
|
<param name="paths"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.PerforceFileSpec.LocalSpecList(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Creates a list of <see cref="T:RSG.Editor.PerforceFileSpec"/> objects from a list of
|
|
local paths.
|
|
</summary>
|
|
<param name="paths"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ReadOnlyChangedEventArgs">
|
|
<summary>
|
|
Provides data for a event that is representing a read-only change to a file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ReadOnlyChangedEventArgs._fullPath">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ReadOnlyChangedEventArgs.FullPath"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ReadOnlyChangedEventArgs.#ctor(System.Boolean,System.Boolean,System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ReadOnlyChangedEventArgs"/> class.
|
|
</summary>
|
|
<param name="oldValue">
|
|
The value before the changed occurred.
|
|
</param>
|
|
<param name="newValue">
|
|
The value after the changed occurred.
|
|
</param>
|
|
<param name="fullpath">
|
|
The full path to the file whose read-only state has changed.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ReadOnlyChangedEventArgs.FullPath">
|
|
<summary>
|
|
Gets the full path to the file whose read-only state has changed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.RelayCommandAsync`1">
|
|
<summary>
|
|
Asynchronous version of the RelayCommand.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the command parameter that should be passed into the delegated can execute
|
|
and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.RelayCommandAsync`1._action">
|
|
<summary>
|
|
Action to execute when the command is invoked.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RelayCommandAsync`1._prediction">
|
|
<summary>
|
|
Function to execute when determining if this command can be executed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RelayCommandAsync`1._executing">
|
|
<summary>
|
|
Flag indicating whether we are currently executing the command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommandAsync`1.#ctor(System.Func{`0,System.Threading.Tasks.Task})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RelayCommandAsync`1"/> class, using
|
|
the specified action method as a command delegate.
|
|
</summary>
|
|
<param name="action">
|
|
The method to call when this command executes.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommandAsync`1.#ctor(System.Func{`0,System.Threading.Tasks.Task},System.Predicate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RelayCommandAsync`1"/> class, using
|
|
the specified prediction and action methods as command delegates.
|
|
</summary>
|
|
<param name="action">
|
|
The method to call when this command executes. This only gets called if the
|
|
specified prediction method returns true.
|
|
</param>
|
|
<param name="prediction">
|
|
The method to call when determining if this command can be executed or not. Can
|
|
be null.
|
|
</param>
|
|
</member>
|
|
<member name="E:RSG.Editor.RelayCommandAsync`1.CanExecuteChanged">
|
|
<summary>
|
|
Occurs when changes occur that affect whether or not the command can be executed by
|
|
the user.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommandAsync`1.CanExecute(System.Object)">
|
|
<summary>
|
|
Gets called when the manager is deciding if this command can be executed. This
|
|
returns true be default.
|
|
</summary>
|
|
<param name="parameter">
|
|
The parameter that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommandAsync`1.ExecuteAsync(System.Object)">
|
|
<summary>
|
|
Asynchronously executes the action.
|
|
</summary>
|
|
<param name="parameter">
|
|
The command parameter that has been setup in the binding to this command.
|
|
</param>
|
|
<returns>
|
|
A task that is executing the command logic.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommandAsync`1.Execute(System.Object)">
|
|
<summary>
|
|
Asynchronously executes the command.
|
|
</summary>
|
|
<param name="parameter">
|
|
The parameter that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommandAsync`1.OnCanExecuteChanged">
|
|
<summary>
|
|
Utility method for raising the CanExecuteChanged event.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.RelayCommand`1">
|
|
<summary>
|
|
Provides a way to bind command attributes to methods within the binding source.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the command parameter that should be passed into the delegated can execute
|
|
and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.RelayCommand`1._action">
|
|
<summary>
|
|
The method to call when this command executes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RelayCommand`1._prediction">
|
|
<summary>
|
|
The method to call when determining if this command can be executed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommand`1.#ctor(System.Action{`0},System.Predicate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RelayCommand`1"/> class, using the
|
|
specified prediction and action methods as command delegates.
|
|
</summary>
|
|
<param name="action">
|
|
The method to call when this command executes. This only gets called if the
|
|
specified prediction method returns true.
|
|
</param>
|
|
<param name="prediction">
|
|
The method to call when determining if this command can be executed or not. Can
|
|
be null.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommand`1.#ctor(System.Action{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RelayCommand`1"/> class, using the
|
|
specified action method as a command delegate.
|
|
</summary>
|
|
<param name="action">
|
|
The method to call when this command executes.
|
|
</param>
|
|
</member>
|
|
<member name="E:RSG.Editor.RelayCommand`1.CanExecuteChanged">
|
|
<summary>
|
|
Occurs when changes occur that affect whether or not the command can be executed by
|
|
the user.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommand`1.CanExecute(System.Object)">
|
|
<summary>
|
|
Gets called when the manager is deciding if this command can be executed. This
|
|
returns true be default if no prediction method was specified at creation time.
|
|
</summary>
|
|
<param name="parameter">
|
|
The command parameter that has been setup in the binding to this command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommand`1.Execute(System.Object)">
|
|
<summary>
|
|
Gets called when the command is executed. This just relays the execution to the
|
|
delegate function.
|
|
</summary>
|
|
<param name="parameter">
|
|
The command parameter that has been setup in the binding to this command.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RelayCommand">
|
|
<summary>
|
|
Command that delegates the CanExecute and Execute methods to actions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommand.#ctor(System.Action{System.Object})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RelayCommand"/> class, using the
|
|
specified action method as a command delegate.
|
|
</summary>
|
|
<param name="action">
|
|
The method to call when this command executes.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommand.#ctor(System.Action{System.Object},System.Predicate{System.Object})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RelayCommand"/> class, using the
|
|
specified prediction and action methods as command delegates.
|
|
</summary>
|
|
<param name="action">
|
|
The method to call when this command executes. This only gets called if the
|
|
specified prediction method returns true.
|
|
</param>
|
|
<param name="prediction">
|
|
The method to call when determining if this command can be executed or not. Can
|
|
be null.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RelayCommandAsync">
|
|
<summary>
|
|
Asynchronous version of the RelayCommand.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommandAsync.#ctor(System.Func{System.Object,System.Threading.Tasks.Task})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RelayCommandAsync"/> class, using the
|
|
specified action method as a command delegate.
|
|
</summary>
|
|
<param name="action">
|
|
The method to call when this command executes.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RelayCommandAsync.#ctor(System.Func{System.Object,System.Threading.Tasks.Task},System.Predicate{System.Object})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RelayCommandAsync"/> class, using the
|
|
specified prediction and action methods as command delegates.
|
|
</summary>
|
|
<param name="action">
|
|
The method to call when this command executes. This only gets called if the
|
|
specified prediction method returns true.
|
|
</param>
|
|
<param name="prediction">
|
|
The method to call when determining if this command can be executed or not. Can
|
|
be null.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarRoutedCommand">
|
|
<summary>
|
|
Defines an ICommand that is routed through the element tree and contains a icon,
|
|
description, and category property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarRoutedCommand._category">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.RockstarRoutedCommand.Category"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarRoutedCommand._description">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.RockstarRoutedCommand.Description"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarRoutedCommand._icon">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.RockstarRoutedCommand.Icon"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarRoutedCommand.#ctor(System.String,System.Type,System.Windows.Input.InputGestureCollection,System.String,System.String,System.Windows.Media.Imaging.BitmapSource)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarRoutedCommand" /> class.
|
|
</summary>
|
|
<param name="name">
|
|
Declared name for serialization.
|
|
</param>
|
|
<param name="ownerType">
|
|
The type that is registering the command.
|
|
</param>
|
|
<param name="inputGestures">
|
|
Default input gestures associated with this command.
|
|
</param>
|
|
<param name="category">
|
|
The name of the category this command belongs to.
|
|
</param>
|
|
<param name="description">
|
|
The description for this command.
|
|
</param>
|
|
<param name="icon">
|
|
The icon this command should use.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarRoutedCommand.Category">
|
|
<summary>
|
|
Gets the category name this command belongs to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarRoutedCommand.Description">
|
|
<summary>
|
|
Gets the description for this command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarRoutedCommand.Icon">
|
|
<summary>
|
|
Gets the icon for this command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SearchAction`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement the search
|
|
commands (search, search next, search previous).
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter passed into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchAction`1._currentSearchData">
|
|
<summary>
|
|
The private cache of the current search data to use with the search next and search
|
|
previous search commands.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchAction`1._resolver">
|
|
<summary>
|
|
The private resolver that this class uses to obtain the command parameter from.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchAction`1._serviceProvider">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchAction`1.ServiceProvider"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SearchAction`1"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchAction`1.ServiceProvider">
|
|
<summary>
|
|
Sets the service provider that can be used in the CanExecute and Execute methods.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchAction`1.Item(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Gets the command definition that has been created for this implementer for the
|
|
specified routed command.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definition should be returned.
|
|
</param>
|
|
<returns>
|
|
The command definition that has been created for this implementer for the specified
|
|
routed command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.AddBinding(System.Windows.UIElement)">
|
|
<summary>
|
|
Binds this implementation to the common search commands and the specified user
|
|
interface element.
|
|
</summary>
|
|
<param name="element">
|
|
The element that this implementation will be bound to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.AddBinding(System.Type)">
|
|
<summary>
|
|
Binds this implementation to the common search commands and registers them with
|
|
the specified class type.
|
|
</summary>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.CanSearch(`0)">
|
|
<summary>
|
|
Override to set logic against the can execute handler for the
|
|
<see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Find"/> command. By default this returns true.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<returns>
|
|
True if the command can be fired; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.ClearSearch(`0)">
|
|
<summary>
|
|
Override to set logic against the execute command handler for the
|
|
<see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Find"/> command when the data indicates the search
|
|
should be cleared.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.GetScopes">
|
|
<summary>
|
|
Override the provide the created definition with the items to show in the filter.
|
|
</summary>
|
|
<returns>
|
|
The items to show in the filter.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.GetService``1">
|
|
<summary>
|
|
Gets the service object of the specified type.
|
|
</summary>
|
|
<typeparam name="TService">
|
|
The type of service object to get.
|
|
</typeparam>
|
|
<returns>
|
|
A service object of the specified type or null if there is no service object of
|
|
that type.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.ModifyDefinition(RSG.Editor.ICommandWithSearchParameters)">
|
|
<summary>
|
|
Override the modify the search parameters on the specified definition.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition that has been created.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.Search(`0,RSG.Editor.SearchData)">
|
|
<summary>
|
|
Override to set logic against the execute command handler for the
|
|
<see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Find"/> command.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="data">
|
|
The search data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if some results were found; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.SearchNext(`0,RSG.Editor.SearchData)">
|
|
<summary>
|
|
Override to set logic against the execute command handler for the
|
|
<see cref="P:RSG.Editor.SharedCommands.RockstarCommands.FindNext"/> command.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="data">
|
|
The search data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the next search result was navigated to successfully; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.SearchPrevious(`0,RSG.Editor.SearchData)">
|
|
<summary>
|
|
Override to set logic against the execute command handler for the
|
|
<see cref="P:RSG.Editor.SharedCommands.RockstarCommands.FindPrevious"/> command.
|
|
</summary>
|
|
<param name="commandParameter">
|
|
The command parameter that has been requested.
|
|
</param>
|
|
<param name="data">
|
|
The search data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the next search result was navigated to successfully; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.CanExecute(RSG.Editor.CanExecuteCommandData)">
|
|
<summary>
|
|
Determines whether the associated command can be executed based on the current
|
|
state of the application.
|
|
</summary>
|
|
<param name="data">
|
|
The can execute data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.CanExecuteWithParameter(RSG.Editor.CanExecuteCommandData{RSG.Editor.SearchData})">
|
|
<summary>
|
|
Determines whether the associated command can be executed based on the current
|
|
state of the application.
|
|
</summary>
|
|
<param name="data">
|
|
The can execute data that has been sent with the command.
|
|
</param>
|
|
<returns>
|
|
True if the command can be executed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.Execute(RSG.Editor.ExecuteCommandData)">
|
|
<summary>
|
|
Called whenever the associated command is fired and needs handling at this instance
|
|
level.
|
|
</summary>
|
|
<param name="data">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.ExecuteWithParameter(RSG.Editor.ExecuteCommandData{RSG.Editor.SearchData})">
|
|
<summary>
|
|
Called whenever the associated command is fired and needs handling at this instance
|
|
level.
|
|
</summary>
|
|
<param name="data">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.SearchAction`1.SearchDefinition">
|
|
<summary>
|
|
The command definition class that is used to create the commands for this
|
|
implementer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchAction`1.SearchDefinition._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchAction`1.SearchDefinition.Command"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchAction`1.SearchDefinition.#ctor(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SearchAction`1.SearchDefinition"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command that this definition is wrapping.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchAction`1.SearchDefinition.Command">
|
|
<summary>
|
|
Gets the System.Windows.Input.RoutedCommand that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandToolBar">
|
|
<summary>
|
|
Creates a object inside the command hierarchy that represents a single toolbar that
|
|
shows a subset of child command bar items.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandToolBar._band">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandToolBar.Band"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandToolBar._bandIndex">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandToolBar.BandIndex"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandToolBar.#ctor(System.Int32,System.Int32,System.String,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandToolBar"/> class.
|
|
</summary>
|
|
<param name="band">
|
|
Where the toolbar should be located in the ToolBarTray.
|
|
</param>
|
|
<param name="bandIndex">
|
|
The position of the toolbar on the band.
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandToolBar.Band">
|
|
<summary>
|
|
Gets or sets a value that indicates where the toolbar should be located in the
|
|
ToolBarTray.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandToolBar.BandIndex">
|
|
<summary>
|
|
Gets or sets the band index number that indicates the position of the toolbar on
|
|
the band.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.DelayPriorityChanges">
|
|
<summary>
|
|
Defines a class that is used to delay the notifications about any priority changes
|
|
seen inside the command system.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DelayPriorityChanges._count">
|
|
<summary>
|
|
The private count value of the current number of instances alive of this object.
|
|
When this reaches zero the notifications will be fired.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DelayPriorityChanges._syncRoot">
|
|
<summary>
|
|
A generic object used to sync access to the count parameter across multiple
|
|
threads.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DelayPriorityChanges.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.DelayPriorityChanges"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DelayPriorityChanges.DisposeManagedResources">
|
|
<summary>
|
|
Disposes of the managed resources and if the delay count parameter is 0 commits
|
|
the changes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.DisposableObject">
|
|
<summary>
|
|
Provides a base class for a object that implements the System.IDisposable interface.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DisposableObject._disposed">
|
|
<summary>
|
|
The private event handler that is used for the <see cref="E:RSG.Editor.DisposableObject.Disposed"/> event.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DisposableObject._disposing">
|
|
<summary>
|
|
The private event handler that is used for the <see cref="E:RSG.Editor.DisposableObject.Disposing"/> event.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.DisposableObject._isDisposed">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.DisposableObject.IsDisposed"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DisposableObject.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.DisposableObject"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DisposableObject.Finalize">
|
|
<summary>
|
|
Finalises an instance of the <see cref="T:RSG.Editor.DisposableObject" /> class.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.DisposableObject.Disposed">
|
|
<summary>
|
|
Occurs when this instance has been disposed by the garage collector or by a user.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.DisposableObject.Disposing">
|
|
<summary>
|
|
Occurs when this instance is being disposed by the garage collector or by a user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.DisposableObject.IsDisposed">
|
|
<summary>
|
|
Gets a value indicating whether this instance has been disposed of.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DisposableObject.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting
|
|
unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DisposableObject.Dispose(System.Boolean)">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting
|
|
unmanaged resources.
|
|
</summary>
|
|
<param name="disposeManaged">
|
|
If true the managed resources for this instance also get disposed of as well as the
|
|
unmanaged resources.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.DisposableObject.DisposeManagedResources">
|
|
<summary>
|
|
When overridden disposes of the managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DisposableObject.DisposeNativeResources">
|
|
<summary>
|
|
When overridden disposes of the unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.DisposableObject.ThrowIfDisposed">
|
|
<summary>
|
|
Throws a System.ObjectDisposedException exception if this instance has been already
|
|
disposed of.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.EmptyTask">
|
|
<summary>
|
|
A static class used to retrieve a static task that has already completed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.EmptyTask._completedTask">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.EmptyTask.CompletedTask"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.EmptyTask.CompletedTask">
|
|
<summary>
|
|
Gets a already completed non-generic task.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.EmptyTask`1">
|
|
<summary>
|
|
A static class used to retrieve a static task that has already completed.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the generic tasks type that is retrieved.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.EmptyTask`1._completedTask">
|
|
<summary>
|
|
The private field used for the <see cref="T:System.Threading.Tasks.Task"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.EmptyTask`1.CompletedTask">
|
|
<summary>
|
|
Gets a already completed generic task.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.FilterCommand">
|
|
<summary>
|
|
Provides a base class to a definition of a filter command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.FilterCommand.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.FilterCommand"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.FilterCommand.CanItemsBeSelected">
|
|
<summary>
|
|
Gets a value indicating whether the individual items are selectable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.FilterCommand.SelectionMode">
|
|
<summary>
|
|
Gets a value indicating the selection mode style adopted by this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ICommandWithScopes">
|
|
<summary>
|
|
When implemented represents a command definition class that contains a collection of
|
|
strings that define the different scopes this command can have.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ICommandWithScopes.Scopes">
|
|
<summary>
|
|
Gets the collection defining the different scopes for this command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ICommandWithSearchParameters">
|
|
<summary>
|
|
When implemented represents a command that contains parameters used for searching.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ICommandWithSearchParameters.CanFilterResults">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can filter the view to just show
|
|
the search results.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ICommandWithSearchParameters.CanUseMatchCase">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can search with case sensitivity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ICommandWithSearchParameters.CanUseMatchWholeWord">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can search for whole words.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ICommandWithSearchParameters.CanUseRegularExpressions">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can search using regular
|
|
expressions.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.IMultiCommandItem">
|
|
<summary>
|
|
Provides a base class to objects representing a item for a
|
|
<see cref="T:RSG.Editor.MultiCommand"/> definition object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMultiCommandItem.Description">
|
|
<summary>
|
|
Gets the description for this item. This is also what is shown as a tooltip along
|
|
with the key gesture if one is set if it is being rendered as a toggle control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMultiCommandItem.Icon">
|
|
<summary>
|
|
Gets the System.Windows.Media.Imaging.BitmapSource object that represents the icon
|
|
that is used for this item if it is being rendered as a toggle control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMultiCommandItem.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this item is currently the selected item on
|
|
the owning command definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMultiCommandItem.KeyGesture">
|
|
<summary>
|
|
Gets or sets the System.Windows.Input.KeyGesture object that is associated with
|
|
this combo command item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMultiCommandItem.ParentDefinition">
|
|
<summary>
|
|
Gets the parent command definition that this is an item for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMultiCommandItem.Text">
|
|
<summary>
|
|
Gets or sets the text that is used to display this item inside the combo control.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMultiCommandItem.GetCommandParameter">
|
|
<summary>
|
|
Gets the command parameter used for this multi command item.
|
|
</summary>
|
|
<returns>
|
|
The command parameter used for this multi command item.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.IMultiCommandItem.SetIsToggled(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Sets the <see cref="P:RSG.Editor.IMultiCommandItem.IsToggled"/> property from an internal operation.
|
|
</summary>
|
|
<param name="isToggled">
|
|
A value to set the <see cref="P:RSG.Editor.IMultiCommandItem.IsToggled"/> property to.
|
|
</param>
|
|
<param name="handleSelectionOnParent">
|
|
A value indicating whether the toggle change should result in it being handled in
|
|
the parent command definition.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.IMultiCommandParameter">
|
|
<summary>
|
|
When implemented represents a command parameter that can be used for a multi command
|
|
item object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.IMultiCommandParameter.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this parameter is currently been sent in
|
|
a toggled state or not.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ModificationField">
|
|
<summary>
|
|
Defines all the different fields that can be modified for a command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.AreMultiItemsShown">
|
|
<summary>
|
|
Defines a modification made to the are multi items shown property of a command bar
|
|
item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.DisplayStyle">
|
|
<summary>
|
|
Defines a modification made to the display style property of a command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.EachItemStartsGroup">
|
|
<summary>
|
|
Defines a modification made to the each item starts group property of a command bar
|
|
item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.Priority">
|
|
<summary>
|
|
Defines a modification made to the priority property of a command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.ShowFilterCount">
|
|
<summary>
|
|
Defines a modification made to the show filter count property of a command bar
|
|
item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.StartsGroup">
|
|
<summary>
|
|
Defines a modification made to the starts group property of a command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.Text">
|
|
<summary>
|
|
Defines a modification made to the text property of a command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.Visibility">
|
|
<summary>
|
|
Defines a modification made to the is visible property of a command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ModificationField.Width">
|
|
<summary>
|
|
Defines a modification made to the width property of a command bar item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.MultiCommandItem`1">
|
|
<summary>
|
|
Provides a base class to objects representing a item for a
|
|
<see cref="T:RSG.Editor.MultiCommand"/> definition object.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type that the actual command parameter is for this multi command item.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItem`1._isToggled">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommandItem`1.IsToggled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItem`1._keyGesture">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommandItem`1.KeyGesture"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItem`1._parentDefinition">
|
|
<summary>
|
|
A reference to the multi item command definition.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItem`1._text">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommandItem`1.Text"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItem`1._commandParameter">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommandItem`1.CommandParameter"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItem`1.#ctor(RSG.Editor.MultiCommand,System.String,`0)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.MultiCommandItem`1"/> class.
|
|
</summary>
|
|
<param name="definition">
|
|
The multi command definition that owns this item.
|
|
</param>
|
|
<param name="text">
|
|
The text that is used to display this item inside the combo control.
|
|
</param>
|
|
<param name="commandParameter">
|
|
The item parameter that is sent with the command if this item is selected in the
|
|
combo control or toggled in the filter control.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItem`1.CommandParameter">
|
|
<summary>
|
|
Gets or sets the generic object that is sent with the command if this item is the
|
|
selected item in the combo control or toggled in the filter control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItem`1.Description">
|
|
<summary>
|
|
Gets the description for this item. This is also what is shown as a tooltip along
|
|
with the key gesture if one is set if it is being rendered as a toggle control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItem`1.Icon">
|
|
<summary>
|
|
Gets the System.Windows.Media.Imaging.BitmapSource object that represents the icon
|
|
that is used for this item if it is being rendered as a toggle control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItem`1.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this item is currently the selected item on
|
|
the owning command definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItem`1.KeyGesture">
|
|
<summary>
|
|
Gets or sets the System.Windows.Input.KeyGesture object that is associated with
|
|
this combo command item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItem`1.ParentDefinition">
|
|
<summary>
|
|
Gets the parent command definition that this is an item for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItem`1.Text">
|
|
<summary>
|
|
Gets or sets the text that is used to display this item inside the combo control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItem`1.KeyGestureText">
|
|
<summary>
|
|
Gets the text that contains the key gesture that is attached to this combo command
|
|
item.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItem`1.GetCommandParameter">
|
|
<summary>
|
|
Gets the command parameter used for this multi command item.
|
|
</summary>
|
|
<returns>
|
|
The command parameter used for this multi command item.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItem`1.SetIsToggled(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Sets the <see cref="P:RSG.Editor.MultiCommandItem`1.IsToggled"/> property from an internal operation.
|
|
</summary>
|
|
<param name="isToggled">
|
|
A value to set the <see cref="P:RSG.Editor.MultiCommandItem`1.IsToggled"/> property to.
|
|
</param>
|
|
<param name="handleSelectionOnParent">
|
|
A value indicating whether the toggle change should result in it being handled in
|
|
the parent command definition.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItem`1.SetIsToggled(System.Boolean)">
|
|
<summary>
|
|
Sets the <see cref="P:RSG.Editor.MultiCommandItem`1.IsToggled"/> property from an internal operation.
|
|
</summary>
|
|
<param name="isToggled">
|
|
A value to set the <see cref="P:RSG.Editor.MultiCommandItem`1.IsToggled"/> property to.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandInstance">
|
|
<summary>
|
|
Provides a abstract base class to all of the objects that will be placed within the
|
|
command bar hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandInstance._command">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandInstance.Command"/> parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandInstance._displayStyle">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommandInstance.DisplayStyle"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandInstance.#ctor(RSG.Editor.RockstarRoutedCommand,System.UInt16,System.Boolean,System.String,System.Guid,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandInstance"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command that this command bar item is instancing.
|
|
</param>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="startsGroup">
|
|
A value indicating whether this command bar item should start a new group. (I.e.
|
|
Placed directly after a separator).
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandInstance.#ctor(System.UInt16,System.Boolean,System.String,System.Guid,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandInstance"/> class.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="startsGroup">
|
|
A value indicating whether this command bar item should start a new group. (I.e.
|
|
Placed directly after a separator).
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandInstance.Command">
|
|
<summary>
|
|
Gets or sets the command that this command bar item is instancing. This ties the
|
|
definition and instance together.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommandInstance.DisplayStyle">
|
|
<summary>
|
|
Gets or sets a value that can be used to change how the control that is used to
|
|
display this item gets styled.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandInstance.UpdateTextValue(System.String)">
|
|
<summary>
|
|
Updates the text making sure the original text is kept as a fall back for when this
|
|
instance is disabled.
|
|
</summary>
|
|
<param name="updatedText">
|
|
The updated text that should replace the existing text.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandItemDisplayType">
|
|
<summary>
|
|
Defines the different ways a command bar item can be displayed to the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Batch">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a batch control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Button">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a button.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Combo">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a combo box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Controller">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a controller item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.DynamicMenu">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a dynamic menu control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.FilterCombo">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a combo box with check
|
|
boxes for each item and a concatenated string for the selection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Menu">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a menu control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Search">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a search control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Separator">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a separator.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Text">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a text box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.Toggle">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a check box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayType.ToolBar">
|
|
<summary>
|
|
Specifies that the command bar item is to be displayed as a toolbar inside the
|
|
tool bar tray.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandMenu">
|
|
<summary>
|
|
Provides a abstract base class to objects inside the command hierarchy that represent a
|
|
simple menu that shows a subset of child command bar items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommandMenu.#ctor(System.UInt16,System.Boolean,System.String,System.Guid,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.CommandMenu"/> class.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="startsGroup">
|
|
A value indicating whether this command bar item should start a new group. (I.e.
|
|
Placed directly after a separator).
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommonIcons">
|
|
<summary>
|
|
Provides static properties that give access to common icons that can be used throughout
|
|
a application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._actionAdd">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.ActionAdd"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._arrowDown">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.ArrowDown"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._arrowUp">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.ArrowUp"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._blankFile">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.BlankFile"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._build">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Build"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._clear">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Clear"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._close">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Close"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._closedFolder">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.ClosedFolder"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._collapse">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Collapse"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._collapseAll">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.CollapseAll"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._copy">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Copy"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._cut">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Cut"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._delete">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Delete"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._error">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Error"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._expand">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Expand"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._expandAll">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.ExpandAll"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._findInFiles">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.FindInFiles"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._findNext">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.FindNext"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._findPrevious">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.FindPrevious"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._gears">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Gears"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._help">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Help"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._lock">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Lock"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._newFile">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.NewFile"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._openedFolder">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.OpenedFolder"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._openFile">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.OpenFile"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._paste">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Paste"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._playstation">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Playstation"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._quickFind">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.QuickFind"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._quickReplace">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.QuickReplace"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._redo">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Redo"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._refresh">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Refresh"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._rename">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Rename"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._replaceInFiles">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.ReplaceInFiles"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._reportBug">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.ReportBug"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._resource">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Resource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._restart">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Restart"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._save">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Save"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._saveAll">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.SaveAll"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._search">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Search"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._selectAll">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.SelectAll"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._syncRoot">
|
|
<summary>
|
|
A generic object that provides thread safety access to the image sources.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._undo">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Undo"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._unknownFile">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.UnknownFile"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._viewDocument">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.ViewDocument"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._warning">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Warning"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._windows">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Windows"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._xbox">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.XBox"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._filter">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.Filter"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._matchCase">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.MatchCase"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._matchWord">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.MatchWord"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommonIcons._regularExpressions">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.CommonIcons.RegularExpressions"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.ActionAdd">
|
|
<summary>
|
|
Gets the icon that shows a add action icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.ArrowDown">
|
|
<summary>
|
|
Gets the icon that shows a arrow pointing down icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.ArrowUp">
|
|
<summary>
|
|
Gets the icon that shows a arrow pointing up icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.BlankFile">
|
|
<summary>
|
|
Gets the icon that shows a blank file icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Build">
|
|
<summary>
|
|
Gets the icon that shows a build icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Clear">
|
|
<summary>
|
|
Gets the icon that shows a clear icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Close">
|
|
<summary>
|
|
Gets the icon that shows a close icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.ClosedFolder">
|
|
<summary>
|
|
Gets the icon that shows a closed folder icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Collapse">
|
|
<summary>
|
|
Gets the icon that shows a collapse icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.CollapseAll">
|
|
<summary>
|
|
Gets the icon that shows a collapse all icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Copy">
|
|
<summary>
|
|
Gets the icon that shows a copy icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Cut">
|
|
<summary>
|
|
Gets the icon that shows a cut icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Delete">
|
|
<summary>
|
|
Gets the icon that shows a delete icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Error">
|
|
<summary>
|
|
Gets the icon that shows a error icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Expand">
|
|
<summary>
|
|
Gets the icon that shows a expand icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.ExpandAll">
|
|
<summary>
|
|
Gets the icon that shows a expand all icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.FindInFiles">
|
|
<summary>
|
|
Gets the icon that shows a find in files icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.FindNext">
|
|
<summary>
|
|
Gets the icon that shows a find next icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.FindPrevious">
|
|
<summary>
|
|
Gets the icon that shows a find previous icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Gears">
|
|
<summary>
|
|
Gets the icon that shows a gears icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Help">
|
|
<summary>
|
|
Gets the icon that shows a help icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Lock">
|
|
<summary>
|
|
Gets the icon that shows a lock icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.NewFile">
|
|
<summary>
|
|
Gets the icon that shows a new file icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.OpenedFolder">
|
|
<summary>
|
|
Gets the icon that shows a opened folder icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.OpenFile">
|
|
<summary>
|
|
Gets the icon that shows a open file icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Paste">
|
|
<summary>
|
|
Gets the icon that shows a open paste icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Playstation">
|
|
<summary>
|
|
Gets the icon that shows a undo icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.QuickFind">
|
|
<summary>
|
|
Gets the icon that shows a quick find icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.QuickReplace">
|
|
<summary>
|
|
Gets the icon that shows a quick replace icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Redo">
|
|
<summary>
|
|
Gets the icon that shows a redo icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Refresh">
|
|
<summary>
|
|
Gets the icon that shows a refresh icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Rename">
|
|
<summary>
|
|
Gets the icon that shows a rename icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.ReplaceInFiles">
|
|
<summary>
|
|
Gets the icon that shows a replace in files icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.ReportBug">
|
|
<summary>
|
|
Gets the icon that shows a replace in files icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Resource">
|
|
<summary>
|
|
Gets the icon that shows a resource icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Restart">
|
|
<summary>
|
|
Gets the icon that shows a restart icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Save">
|
|
<summary>
|
|
Gets the icon that shows a save to disk icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.SaveAll">
|
|
<summary>
|
|
Gets the icon that shows a save all icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Search">
|
|
<summary>
|
|
Gets the icon that shows a search icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.SelectAll">
|
|
<summary>
|
|
Gets the icon that shows a select all icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Undo">
|
|
<summary>
|
|
Gets the icon that shows a undo icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.UnknownFile">
|
|
<summary>
|
|
Gets the icon that shows a unknown file icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.ViewDocument">
|
|
<summary>
|
|
Gets the icon that shows a View Document icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Warning">
|
|
<summary>
|
|
Gets the icon that shows a warning icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Windows">
|
|
<summary>
|
|
Gets the icon that shows a save all icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.XBox">
|
|
<summary>
|
|
Gets the icon that shows a select all icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.Filter">
|
|
<summary>
|
|
Gets the icon that shows a filter items icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.MatchCase">
|
|
<summary>
|
|
Gets the icon that shows a match case icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.MatchWord">
|
|
<summary>
|
|
Gets the icon that shows a match whole word icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.CommonIcons.RegularExpressions">
|
|
<summary>
|
|
Gets the icon that shows a regular expressions icon.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.CommonIcons.EnsureLoaded(System.Windows.Media.Imaging.BitmapSource@,System.String)">
|
|
<summary>
|
|
Ensures that the specified image source is loaded with the specified resource name.
|
|
</summary>
|
|
<param name="source">
|
|
The image source that should be loaded.
|
|
</param>
|
|
<param name="resourceName">
|
|
The name of the resource the loaded image source should set as its source.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandItemDisplayStyle">
|
|
<summary>
|
|
Defines the different ways a command bar item can be displayed to the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayStyle.Default">
|
|
<summary>
|
|
Specifies that the command bar item is to be styled as default based on the type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayStyle.ImageOnly">
|
|
<summary>
|
|
Specifies that the command bar item is to be styled so that only the image is ever
|
|
displayed to the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayStyle.TextOnly">
|
|
<summary>
|
|
Specifies that the command bar item is to be styled so that only the text is ever
|
|
displayed to the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandItemDisplayStyle.ImageAndText">
|
|
<summary>
|
|
Specifies that the command bar item is to be styled so that both the icon and the
|
|
text is displayed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.CommandType">
|
|
<summary>
|
|
Defines the different ways a command bar item can be displayed to the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandType.Batch">
|
|
<summary>
|
|
Specifies that the command is to be displayed as a batch control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandType.Button">
|
|
<summary>
|
|
Specifies that the command is to be displayed as a button.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandType.Combo">
|
|
<summary>
|
|
Specifies that the command is to be displayed as a combo box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandType.Controller">
|
|
<summary>
|
|
Specifies that the command is to be displayed as a controller item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandType.Text">
|
|
<summary>
|
|
Specifies that the command is to be displayed as a text box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.CommandType.Toggle">
|
|
<summary>
|
|
Specifies that the command is to be displayed as a check box.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ICommandWithParameter">
|
|
<summary>
|
|
When implemented represents a command definition class that contains a command
|
|
parameter property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ICommandWithParameter.CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ICommandWithToggle">
|
|
<summary>
|
|
When implemented represents a command definition class that contains a toggle flag
|
|
property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ICommandWithToggle.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this definition is currently in the toggled
|
|
state or not.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.KeyGestureComparer">
|
|
<summary>
|
|
Defines methods to support the comparison of two instances of the
|
|
System.Windows.Input.KeyGesture class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.KeyGestureComparer.Equals(System.Windows.Input.KeyGesture,System.Windows.Input.KeyGesture)">
|
|
<summary>
|
|
Determines whether the specified objects are equal.
|
|
</summary>
|
|
<param name="x">
|
|
The first object of type T to compare.
|
|
</param>
|
|
<param name="y">
|
|
The second object of type T to compare.
|
|
</param>
|
|
<returns>
|
|
True if the specified objects are equal; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.KeyGestureComparer.GetHashCode(System.Windows.Input.KeyGesture)">
|
|
<summary>
|
|
Returns a hash code for the specified object.
|
|
</summary>
|
|
<param name="obj">
|
|
The System.Object for which a hash code is to be returned.
|
|
</param>
|
|
<returns>
|
|
A hash code for the specified object.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.MultiCommand">
|
|
<summary>
|
|
Represents a command definition that can automatically add command bar items within
|
|
its own instance. This can be used for example for a most recently used list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommand._defaultSelection">
|
|
<summary>
|
|
The private reference to the item that should be selected by default.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommand._items">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommand.Items"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommand._selectedItem">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommand.SelectedItem"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommand.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.MultiCommand"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommand.AreItemsSingleSelectable">
|
|
<summary>
|
|
Gets a value indicating whether the individual items are selectable and only one
|
|
item can be selected at a time.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommand.CanItemsBeSelected">
|
|
<summary>
|
|
Gets a value indicating whether the individual items are selectable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommand.Items">
|
|
<summary>
|
|
Gets a collection of items that represent the different items that can be executed
|
|
through this command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommand.SelectedItem">
|
|
<summary>
|
|
Gets or sets the item that is currently selected.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommand.SelectionMode">
|
|
<summary>
|
|
Gets a value indicating the selection mode style adopted by this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommand.DeserialiseState(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Deserialises the commands state using the data contained within the specified xml
|
|
reader.
|
|
</summary>
|
|
<param name="reader">
|
|
The xml reader that contains the state data.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
<returns>
|
|
A value indicating whether the command needs to be executed due to the
|
|
de-serialisation process.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommand.SerialiseState(System.Xml.XmlWriter,System.IFormatProvider)">
|
|
<summary>
|
|
Serialises the state of this definition into the specified xml writer.
|
|
</summary>
|
|
<param name="writer">
|
|
The xml writer that the state gets serialised out to.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommand.SetDefaultSelection(RSG.Editor.IMultiCommandItem)">
|
|
<summary>
|
|
Sets up the item that is selected by default.
|
|
</summary>
|
|
<param name="item">
|
|
Specifies the item that should be selected by default.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommand.ItemsChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
|
|
<summary>
|
|
Gets called whenever the items collection is changed.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.CollectionChangeEventArgs data for the event.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.MultiCommandItemDefinition">
|
|
<summary>
|
|
Represents the definition to use for a single multi item command item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItemDefinition._item">
|
|
<summary>
|
|
The private reference to the definition item that is being wrapped.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItemDefinition._originalDefinition">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommandItemDefinition.OriginalDefinition"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItemDefinition.#ctor(RSG.Editor.IMultiCommandItem,RSG.Editor.MultiCommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.MultiCommandItemDefinition"/> class.
|
|
</summary>
|
|
<param name="item">
|
|
The definition item that is being wrapped.
|
|
</param>
|
|
<param name="definition">
|
|
The original command definition that has had its items expanded.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.CategoryName">
|
|
<summary>
|
|
Gets the command category name this definition belongs to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.Command">
|
|
<summary>
|
|
Gets the System.Windows.Input.RoutedCommand that this definition is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.Description">
|
|
<summary>
|
|
Gets the description for this command. This is also what is shown as a tooltip
|
|
along with the key gesture if one is set.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.Icon">
|
|
<summary>
|
|
Gets the System.Windows.Media.Imaging.BitmapSource object that represents the icon
|
|
that is used for this command, this can be null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.RSG#Editor#ICommandWithParameter#CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.RSG#Editor#ICommandWithToggle#IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this definition is currently in the toggled
|
|
state or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this definition is currently in the toggled
|
|
state or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.KeyGesture">
|
|
<summary>
|
|
Gets or sets the System.Windows.Input.KeyGesture object that is associated with
|
|
this command definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.MultiCommandItems">
|
|
<summary>
|
|
Gets the collection containing the multi items that make up the items in the
|
|
command that this definition has been expanded into.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemDefinition.OriginalDefinition">
|
|
<summary>
|
|
Gets the reference to the original command definition that has been expanded into
|
|
multiple items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItemDefinition.OnItemChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Gets called whenever a property on the associated item changes.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs event data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.MultiCommandItemInstance">
|
|
<summary>
|
|
Represents the item to use for a single multi item command item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItemInstance._item">
|
|
<summary>
|
|
The private reference to the command item that is being instanced.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItemInstance._originalInstance">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommandItemInstance.OriginalInstance"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItemInstance.#ctor(RSG.Editor.CommandInstance,RSG.Editor.IMultiCommandItem)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.MultiCommandItemInstance"/> class.
|
|
</summary>
|
|
<param name="instance">
|
|
The original command instance that is being expanded.
|
|
</param>
|
|
<param name="item">
|
|
The multi command item that is being instanced.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.AreMultiItemsShown">
|
|
<summary>
|
|
Gets a value indicating whether the individual items are shown to the user for this
|
|
instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.DisplayStyle">
|
|
<summary>
|
|
Gets or sets a value that can be used to change how the control that is used to
|
|
display this item gets styled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.EachItemStartsGroup">
|
|
<summary>
|
|
Gets or sets a value indicating whether the individual items start a group each or
|
|
not. Only applicable when instancing a multi command with
|
|
<see cref="P:RSG.Editor.MultiCommandItemInstance.AreMultiItemsShown"/> set to true.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.IsVisible">
|
|
<summary>
|
|
Gets or sets a value indicating whether this command bar item is visible to the
|
|
user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.OriginalInstance">
|
|
<summary>
|
|
Gets the reference to the original command instance that has been expanded into
|
|
multiple items.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.Priority">
|
|
<summary>
|
|
Gets or sets the priority of the item which indicates the position of it relative
|
|
to the other items under the same parent.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.SiblingCount">
|
|
<summary>
|
|
Gets the number of siblings the are apart of the same multi command expansion as
|
|
this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.StartsGroup">
|
|
<summary>
|
|
Gets or sets a value indicating whether this item is proceeded by a separator to
|
|
indicate the start of a new group inside the command bar hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemInstance.Text">
|
|
<summary>
|
|
Gets or sets the text for this command bar item. This appears on the menu item in
|
|
the hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItemInstance.OnItemChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Gets called whenever a property on the associated item changes.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs event data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.MultiCommandItemViewModel">
|
|
<summary>
|
|
The view model class that wraps a single <see cref="T:RSG.Editor.IMultiCommandItem"/> object to be
|
|
used by the view.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItemViewModel._item">
|
|
<summary>
|
|
The private <see cref="T:RSG.Editor.IMultiCommandItem"/> object this view model is wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandItemViewModel._parent">
|
|
<summary>
|
|
The parent view model for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItemViewModel.#ctor(RSG.Editor.IMultiCommandItem,RSG.Editor.CommandBarItemViewModel)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.MultiCommandItemViewModel"/> class.
|
|
</summary>
|
|
<param name="item">
|
|
The <see cref="T:RSG.Editor.IMultiCommandItem"/> object this view model is wrapping.
|
|
</param>
|
|
<param name="parent">
|
|
The parent view model.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemViewModel.CommandParameter">
|
|
<summary>
|
|
Gets the generic object that is sent with the command if this item is the selected
|
|
item in the combo control or toggled in the filter control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemViewModel.Description">
|
|
<summary>
|
|
Gets the description for this item. This is also what is shown as a tooltip along
|
|
with the key gesture if one is set if it is being rendered as a toggle control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemViewModel.Icon">
|
|
<summary>
|
|
Gets the System.Windows.Media.Imaging.BitmapSource object that represents the icon
|
|
that is used for this item if it is being rendered as a toggle control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemViewModel.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this item is currently the selected item on
|
|
the owning command definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemViewModel.KeyGesture">
|
|
<summary>
|
|
Gets or sets the System.Windows.Input.KeyGesture object that is associated with
|
|
this combo command item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemViewModel.Model">
|
|
<summary>
|
|
Gets the model for this view model.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemViewModel.ParentDefinition">
|
|
<summary>
|
|
Gets the parent command definition that this is an item for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandItemViewModel.Text">
|
|
<summary>
|
|
Gets or sets the text that is used to display this item inside the combo control.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItemViewModel.GetCommandParameter">
|
|
<summary>
|
|
Gets the command parameter used for this multi command item.
|
|
</summary>
|
|
<returns>
|
|
The command parameter used for this multi command item.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItemViewModel.SetIsToggled(System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Sets the <see cref="P:RSG.Editor.MultiCommandItemViewModel.IsToggled"/> property from an internal operation.
|
|
</summary>
|
|
<param name="isToggled">
|
|
A value to set the <see cref="P:RSG.Editor.MultiCommandItemViewModel.IsToggled"/> property to.
|
|
</param>
|
|
<param name="handleSelectionOnParent">
|
|
A value indicating whether the toggle change should result in it being handled in
|
|
the parent command definition.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandItemViewModel.ItemPropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Called whenever a property value changes inside the associated multi command item.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs data for this event.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.MultiCommandParameter`1">
|
|
<summary>
|
|
The command parameter used for a multi command item object.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the actual command parameter value.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandParameter`1._isToggled">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommandParameter`1.IsToggled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandParameter`1._itemParameter">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.MultiCommandParameter`1.ItemParameter"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.MultiCommandParameter`1.#ctor(`0)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.MultiCommandParameter`1"/> class.
|
|
</summary>
|
|
<param name="itemParameter">
|
|
The actual command parameter value for the multi command item object this is
|
|
being used for.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandParameter`1.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this parameter is currently been sent in
|
|
a toggled state or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.MultiCommandParameter`1.ItemParameter">
|
|
<summary>
|
|
Gets the actual command parameter value for the multi command item object this is
|
|
being used for.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.MultiCommandSelectionMode">
|
|
<summary>
|
|
Defines the different selection modes a <see cref="T:RSG.Editor.MultiCommand"/> instance can
|
|
adopt.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandSelectionMode.Single">
|
|
<summary>
|
|
Indicates that only a single item can be selected at once. Used for combo
|
|
commands.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.MultiCommandSelectionMode.Multiple">
|
|
<summary>
|
|
Indicates that one or more items can be selected at the same time. Used for
|
|
filter commands.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.Resources.CommandStringTable">
|
|
<summary>
|
|
Provides the ability to lookup string resources inside the local string table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Resources.CommandStringTable._manager">
|
|
<summary>
|
|
The private reference to the resource manager that contains all of the strings
|
|
located inside the string table.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Resources.CommandStringTable.GetString(System.String)">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<returns>
|
|
The embedded string resource indexed by the specified identifier.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Resources.CommandStringTable.GetString(System.String,System.String[])">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier
|
|
formatted with the specified arguments.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<param name="args">
|
|
An object array that contains zero or more objects to format.
|
|
</param>
|
|
<returns>
|
|
The embedded string resource indexed by the specified identifier in which the
|
|
format items have been replaced by the string representations of the corresponding
|
|
objects in <paramref name="args"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Resources.CommandStringTable.InitialiseManager">
|
|
<summary>
|
|
Creates the resource manager that contains the embedded string resources.
|
|
</summary>
|
|
<returns>
|
|
The newly created System.Resources.ResourceManager object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Resources.CommandStringTable.TryToGetString(System.String,System.Globalization.CultureInfo)">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<param name="cultureInfo">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
<returns>
|
|
A structure containing the result of the operation and a value indicating whether
|
|
the resource was successfully located.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.Resources.ErrorStringTable">
|
|
<summary>
|
|
Provides the ability to lookup string resources inside the local string table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.Resources.ErrorStringTable._manager">
|
|
<summary>
|
|
The private reference to the resource manager that contains all of the strings
|
|
located inside the string table.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.Resources.ErrorStringTable.GetString(System.String)">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<returns>
|
|
The embedded string resource indexed by the specified identifier.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Resources.ErrorStringTable.GetString(System.String,System.String[])">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier
|
|
formatted with the specified arguments.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<param name="args">
|
|
An object array that contains zero or more objects to format.
|
|
</param>
|
|
<returns>
|
|
The embedded string resource indexed by the specified identifier in which the
|
|
format items have been replaced by the string representations of the corresponding
|
|
objects in <paramref name="args"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Resources.ErrorStringTable.InitialiseManager">
|
|
<summary>
|
|
Creates the resource manager that contains the embedded string resources.
|
|
</summary>
|
|
<returns>
|
|
The newly created System.Resources.ResourceManager object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.Resources.ErrorStringTable.TryToGetString(System.String,System.Globalization.CultureInfo)">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<param name="cultureInfo">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
<returns>
|
|
A structure containing the result of the operation and a value indicating whether
|
|
the resource was successfully located.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.Resources.StringTable">
|
|
<summary>
|
|
A strongly-typed resource class, for looking up localized strings, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.ResourceManager">
|
|
<summary>
|
|
Returns the cached ResourceManager instance used by this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.Culture">
|
|
<summary>
|
|
Overrides the current thread's CurrentUICulture property for all
|
|
resource lookups using this strongly typed resource class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.AboutButtonText">
|
|
<summary>
|
|
Looks up a localized string similar to _About....
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.ActionsMenuText">
|
|
<summary>
|
|
Looks up a localized string similar to _Actions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.EditMenuText">
|
|
<summary>
|
|
Looks up a localized string similar to _Edit.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.ExitButtonText">
|
|
<summary>
|
|
Looks up a localized string similar to E_xit.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.FileMenuText">
|
|
<summary>
|
|
Looks up a localized string similar to _File.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.HelpMenuText">
|
|
<summary>
|
|
Looks up a localized string similar to _Help.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.HelpToolBarName">
|
|
<summary>
|
|
Looks up a localized string similar to Help.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.NewMenuName">
|
|
<summary>
|
|
Looks up a localized string similar to New Menu.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.NewToolbarName">
|
|
<summary>
|
|
Looks up a localized string similar to New Toolbar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.ReportBugButtonText">
|
|
<summary>
|
|
Looks up a localized string similar to Report _Bug.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.ToolTipTemplate">
|
|
<summary>
|
|
Looks up a localized string similar to {0} ({1}).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.TopLevelMenuProjectText">
|
|
<summary>
|
|
Looks up a localized string similar to _Project.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.TopLevelMenuViewText">
|
|
<summary>
|
|
Looks up a localized string similar to _View.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.UnknownCommandCategory">
|
|
<summary>
|
|
Looks up a localized string similar to Unknown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.Resources.StringTable.ViewHelpButtonText">
|
|
<summary>
|
|
Looks up a localized string similar to _View Help.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandBindingUtil">
|
|
<summary>
|
|
Provides a utility class that can be used be the command binding objects to support
|
|
key gestures.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandBindingUtil._keyboardHelper">
|
|
<summary>
|
|
The private reference to the keyboard helper class that is used to determine the
|
|
last pressed key.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.#cctor">
|
|
<summary>
|
|
Initialises static members of the <see cref="T:RSG.Editor.RockstarCommandBindingUtil"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.Initialise">
|
|
<summary>
|
|
Initialises the static properties within this static class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.GetExecutedKeyGesture(System.Windows.Input.ExecutedRoutedEventArgs)">
|
|
<summary>
|
|
Determines whether the specified routed event arguments have been created due to a
|
|
key gesture being pressed and returns that key gesture.
|
|
</summary>
|
|
<param name="e">
|
|
The routed event arguments used to determine if there is a key gesture associated
|
|
with it.
|
|
</param>
|
|
<returns>
|
|
The key gesture that was pressed to created the specified event arguments.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.GetExecutedKeyGesture(System.Windows.Input.CanExecuteRoutedEventArgs)">
|
|
<summary>
|
|
Determines whether the specified routed event arguments have been created due to a
|
|
key gesture being pressed and returns that key gesture.
|
|
</summary>
|
|
<param name="e">
|
|
The routed event arguments used to determine if there is a key gesture associated
|
|
with it.
|
|
</param>
|
|
<returns>
|
|
The key gesture that was pressed to create the specified event arguments.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.HandleExection(RSG.Editor.CommandDefinition,System.Windows.Input.KeyGesture,System.Object)">
|
|
<summary>
|
|
Handles the aftermath of a command executing using a keyboard gesture.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition of the command that was fired that was fired.
|
|
</param>
|
|
<param name="gesture">
|
|
The gesture that was used to execute this command.
|
|
</param>
|
|
<param name="parameter">
|
|
The parameter that was sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.GetExecutedKeyGesture(System.Windows.Input.ICommand,System.Object)">
|
|
<summary>
|
|
Determines whether the specified routed event arguments have been created due to a
|
|
key gesture being pressed and returns that key gesture.
|
|
</summary>
|
|
<param name="command">
|
|
The command that was past into the event handler as data.
|
|
</param>
|
|
<param name="parameter">
|
|
The parameter that was past into the event handler as data.
|
|
</param>
|
|
<returns>
|
|
The key gesture that was pressed to create the specified event arguments.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper">
|
|
<summary>
|
|
A helper class that is used to capture the last key down event the keyboard fires.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper._previousKeyDownEventKey">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper.PreviousKeyDownEventKey"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper.PreviousKeyDownEventKey">
|
|
<summary>
|
|
Gets the key that was last past into the key down keyboard event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper.ResetKey">
|
|
<summary>
|
|
Resets the <see cref="P:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper.PreviousKeyDownEventKey"/> property back to the Key.None
|
|
value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBindingUtil.KeyboardHelper.OnPostProcessInput(System.Object,System.Windows.Input.ProcessInputEventArgs)">
|
|
<summary>
|
|
Handles the post process input event on the current input manager. This is used
|
|
to pull out the key event args for the next keyboard event.
|
|
</summary>
|
|
<param name="sender">
|
|
The object that this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The event data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager">
|
|
<summary>
|
|
Responsible for managing all of the defined command sets for this application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._addedCommandBarItems">
|
|
<summary>
|
|
The private list containing all of the command bar items defined for this command
|
|
manager that have been added as user created.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._allCommandBarItems">
|
|
<summary>
|
|
The private list containing all of the command bar items defined for this command
|
|
manager included the removed ones.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._commandBarItems">
|
|
<summary>
|
|
The private list containing all of the command bar items defined for this command
|
|
manager.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._commandDefinitions">
|
|
<summary>
|
|
The private list containing all of the command definitions defined for this command
|
|
manager.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._modifications">
|
|
<summary>
|
|
The private dictionary containing the modification made to the command bar items.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._modificationXmlNames">
|
|
<summary>
|
|
The private dictionary containing the modification fields and their xml names.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._originalValues">
|
|
<summary>
|
|
The private dictionary containing the original values of a the command bar item
|
|
before any modifications are applied.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._removedCommandBarItemIds">
|
|
<summary>
|
|
The private list containing all of the command bar items defined for this command
|
|
manager that have been removed by the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._removedCommandBarItems">
|
|
<summary>
|
|
The private list containing all of the command bar items defined for this command
|
|
manager that have been removed by the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._syncRoot">
|
|
<summary>
|
|
A generic object that provides synchronisation between multiple threads while
|
|
operating on this class.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._delayingPriorityChanges">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.RockstarCommandManager.DelayingPriorityChanges"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._fileMenuId">
|
|
<summary>
|
|
The private instance used for the <see cref="P:RSG.Editor.RockstarCommandManager.FileMenuId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._helpMenuId">
|
|
<summary>
|
|
The private instance used for the <see cref="P:RSG.Editor.RockstarCommandManager.HelpMenuId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._helpToolBarId">
|
|
<summary>
|
|
The private instance used for the <see cref="P:RSG.Editor.RockstarCommandManager.HelpToolBarId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._mainMenuId">
|
|
<summary>
|
|
The private instance used for the <see cref="P:RSG.Editor.RockstarCommandManager.MainMenuId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager._toolBarTrayId">
|
|
<summary>
|
|
The private instance used for the <see cref="P:RSG.Editor.RockstarCommandManager.ToolBarTrayId"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.#cctor">
|
|
<summary>
|
|
Initialises static members of the <see cref="T:RSG.Editor.RockstarCommandManager"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.AllCategories">
|
|
<summary>
|
|
Gets a iterator over all of the command categories.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.AllCommandBarItems">
|
|
<summary>
|
|
Gets a iterator over all of the command bar items.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.AllCommandDefinitions">
|
|
<summary>
|
|
Gets a iterator over all of the command definitions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.AllKeyGestures">
|
|
<summary>
|
|
Gets a iterator over all of the input gestures currently being used on the command
|
|
definitions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.FileMenuId">
|
|
<summary>
|
|
Gets the global identifier used for the file menu.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.HasModifications">
|
|
<summary>
|
|
Gets a value indicating whether there are any modifications currently registered
|
|
with this manager.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.HelpMenuId">
|
|
<summary>
|
|
Gets the global identifier used for the help menu.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.HelpToolBarId">
|
|
<summary>
|
|
Gets the global identifier used for the help toolbar.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.ToolBarTrayId">
|
|
<summary>
|
|
Gets the global identifier used to for the toolbar tray.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.DelayingPriorityChanges">
|
|
<summary>
|
|
Gets or sets a value indicating whether the priority changes are currently getting
|
|
delayed for the next commit.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.MainMenuId">
|
|
<summary>
|
|
Gets the global identifier used for the main menu.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddActionsMenu(System.Guid)">
|
|
<summary>
|
|
Adds the action menu into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference the actions menu.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBinding(System.Windows.UIElement,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="element">
|
|
The element to attached the binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBinding(System.Windows.UIElement,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate,RSG.Editor.CanExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="element">
|
|
The element to attached the binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBinding(System.Type,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBinding(System.Type,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate,RSG.Editor.CanExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBinding``1(System.Windows.UIElement,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{``0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can
|
|
execute methods.
|
|
</typeparam>
|
|
<param name="element">
|
|
The element to attached the binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBinding``1(System.Windows.UIElement,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{``0},RSG.Editor.CanExecuteCommandDelegate{``0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can
|
|
execute methods.
|
|
</typeparam>
|
|
<param name="element">
|
|
The element to attached the binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBinding``1(System.Type,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{``0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can
|
|
execute methods.
|
|
</typeparam>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBinding``1(System.Type,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{``0},RSG.Editor.CanExecuteCommandDelegate{``0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can
|
|
execute methods.
|
|
</typeparam>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBindingAsync(System.Windows.UIElement,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="element">
|
|
The element to attached the binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBindingAsync(System.Windows.UIElement,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate,RSG.Editor.CanExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="element">
|
|
The element to attached the binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBindingAsync``1(System.Windows.UIElement,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{``0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can
|
|
execute methods.
|
|
</typeparam>
|
|
<param name="element">
|
|
The element to attached the binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBindingAsync``1(System.Windows.UIElement,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{``0},RSG.Editor.CanExecuteCommandDelegate{``0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can
|
|
execute methods.
|
|
</typeparam>
|
|
<param name="element">
|
|
The element to attached the binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBindingAsync(System.Type,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBindingAsync``1(System.Type,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{``0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can
|
|
execute methods.
|
|
</typeparam>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBindingAsync(System.Type,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate,RSG.Editor.CanExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddBindingAsync``1(System.Type,System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{``0},RSG.Editor.CanExecuteCommandDelegate{``0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can
|
|
execute methods.
|
|
</typeparam>
|
|
<param name="type">
|
|
The class with which to register the command binding to.
|
|
</param>
|
|
<param name="command">
|
|
The command that the specified execution handler will be bound to.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddCommandBarItem(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Adds the specified item into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="item">
|
|
The item to add to the collection of managed command bar items.
|
|
</param>
|
|
<returns>
|
|
Returns the added command bar item if added successfully.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddCommandDefinition(RSG.Editor.CommandDefinition)">
|
|
<summary>
|
|
Adds the specified command definition into this manager.
|
|
</summary>
|
|
<param name="definition">
|
|
The command definition to add into this manager.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddCommandInstance(RSG.Editor.RockstarRoutedCommand,System.UInt16,System.Boolean,System.String,System.Guid,System.Guid)">
|
|
<summary>
|
|
Adds a new command instance item into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="command">
|
|
The command that the command bar item is instancing.
|
|
</param>
|
|
<param name="priority">
|
|
The initial priority that the command bar item should be given.
|
|
</param>
|
|
<param name="startsGroup">
|
|
A value indicating whether the command bar item should start a new group. (I.e.
|
|
Placed directly after a separator).
|
|
</param>
|
|
<param name="text">
|
|
The text for the command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference the created item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of the item inside the command bar hierarchy.
|
|
</param>
|
|
<returns>
|
|
Returns the added command bar item if added successfully.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddCommandInstance(RSG.Editor.RockstarRoutedCommand,System.UInt16,System.Boolean,System.String,System.Guid,System.Guid,RSG.Editor.CommandInstanceCreationArgs)">
|
|
<summary>
|
|
Adds a new command instance item into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="command">
|
|
The command that the command bar item is instancing.
|
|
</param>
|
|
<param name="priority">
|
|
The initial priority that the command bar item should be given.
|
|
</param>
|
|
<param name="startsGroup">
|
|
A value indicating whether the command bar item should start a new group. (I.e.
|
|
Placed directly after a separator).
|
|
</param>
|
|
<param name="text">
|
|
The text for the command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference the created item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of the item inside the command bar hierarchy.
|
|
</param>
|
|
<param name="additional">
|
|
A argument class that contains additional arguments that can be added to the
|
|
created command instance.
|
|
</param>
|
|
<returns>
|
|
Returns the added command bar item if added successfully.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddEditMenu(System.Guid)">
|
|
<summary>
|
|
Adds the edit menu into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference the edit menu.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddFileMenu(System.Guid)">
|
|
<summary>
|
|
Adds the file menu into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference the file menu.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddHelpMenu(System.Guid)">
|
|
<summary>
|
|
Adds the help menu into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference the help menu.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddMenu(System.UInt16,System.String,System.Guid,System.Guid)">
|
|
<summary>
|
|
Adds a new menu item into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
<returns>
|
|
Returns the added command bar item if added successfully.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddMenu(System.UInt16,System.Boolean,System.String,System.Guid,System.Guid)">
|
|
<summary>
|
|
Adds a new menu item into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="startsGroup">
|
|
A value indicating whether this menu should start a new group. (I.e. Placed
|
|
directly after a separator).
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
<returns>
|
|
Returns the added command bar item if added successfully.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddProjectMenu(System.Guid)">
|
|
<summary>
|
|
Adds the project menu into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference the help menu.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddToolbar(System.Int32,System.Int32,System.String,System.Guid)">
|
|
<summary>
|
|
Adds a new toolbar into this manager.
|
|
</summary>
|
|
<param name="band">
|
|
Where the toolbar should be located in the ToolBarTray.
|
|
</param>
|
|
<param name="bandIndex">
|
|
The position of the toolbar on the band.
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddTopLevelMenu(System.UInt16,System.String,System.Guid)">
|
|
<summary>
|
|
Adds a new top level menu into this manager.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddViewMenu(System.Guid)">
|
|
<summary>
|
|
Adds the view menu into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference the view menu.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.ClearModifications(System.Boolean)">
|
|
<summary>
|
|
Clears all of the current modifications for the command system with a option
|
|
specifying whether or not they should be available in the next session.
|
|
</summary>
|
|
<param name="permanently">
|
|
A value indicating whether the current modifications should be available during the
|
|
next session.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.ClearModifications(System.Guid)">
|
|
<summary>
|
|
Clears the modifications off any items whose parents identifier is specified.
|
|
</summary>
|
|
<param name="parentId">
|
|
The identifier to the command bar item whose children are to be reset.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetDefinition(System.Windows.Input.ICommand)">
|
|
<summary>
|
|
Gets the command definition that is wrapping the specified command.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definition should be retrieved.
|
|
</param>
|
|
<returns>
|
|
The command definition that is wrapping the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetDefinitions(System.String)">
|
|
<summary>
|
|
Gets the command definitions that are inside the specified category.
|
|
</summary>
|
|
<param name="category">
|
|
The category whose definitions should be retrieved.
|
|
</param>
|
|
<returns>
|
|
The command definitions that are inside the specified category.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.HasModificationsForParent(System.Guid)">
|
|
<summary>
|
|
Determines whether any of the children for the specified command bar item have had
|
|
modifications placed upon them.
|
|
</summary>
|
|
<param name="parentId">
|
|
The identifier to the command bar item whose children will be checked.
|
|
</param>
|
|
<returns>
|
|
True if any of the children for the specified identifier have been modified.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.RegisterModification(RSG.Editor.CommandBarItem,RSG.Editor.ModificationField,System.String)">
|
|
<summary>
|
|
Registers a modification made to a command bar item for a specified field.
|
|
</summary>
|
|
<param name="item">
|
|
The item that has been modified.
|
|
</param>
|
|
<param name="field">
|
|
The field that has been modified on the specified item.
|
|
</param>
|
|
<param name="oldValue">
|
|
The old value of the field before the modification was made.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.RemoveCommandBarItem(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Removes the first occurrence of the specified item from the collection of managed
|
|
command bar items.
|
|
</summary>
|
|
<param name="item">
|
|
The item to remove from the collection of managed command bar items.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.UpdateItemText(System.Windows.Input.ICommand,System.String)">
|
|
<summary>
|
|
Update the text property on all of the command instances that represent the
|
|
specified command.
|
|
</summary>
|
|
<param name="command">
|
|
The command of the instances to update.
|
|
</param>
|
|
<param name="updatedText">
|
|
The text that should replace the existing text.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddOriginalPriorityValue(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Adds the current value for the specified items priority to the original mapping
|
|
field.
|
|
</summary>
|
|
<param name="item">
|
|
The item whose priority value should be stored in the original mapping field.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.DeserialiseCommands(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Deserialises the commands using the data contained within the specified xml reader.
|
|
</summary>
|
|
<param name="reader">
|
|
The xml reader that contains the command data.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetCommands(System.Guid)">
|
|
<summary>
|
|
Retrieves a iterator over the collection of command bar items that have their
|
|
parent id set to the specified id.
|
|
</summary>
|
|
<param name="parentId">
|
|
The id whose children will be part of the retrieved iterator.
|
|
</param>
|
|
<returns>
|
|
A iterator over the collection of command bar items that have their parent id set
|
|
to the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetCommandsWithRemovals(System.Guid)">
|
|
<summary>
|
|
Retrieves a iterator over the collection of command bar items that have their
|
|
parent id set to the specified id.
|
|
</summary>
|
|
<param name="parentId">
|
|
The id whose children will be part of the retrieved iterator.
|
|
</param>
|
|
<returns>
|
|
A iterator over the collection of command bar items that have their parent id set
|
|
to the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetInstances(RSG.Editor.CommandDefinition)">
|
|
<summary>
|
|
Gets a iterator around all of the command instances for the specified definition.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition whose instances are iterated through.
|
|
</param>
|
|
<returns>
|
|
A iterator around all of the command instances for the specified definition.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetInstances(System.Windows.Input.ICommand)">
|
|
<summary>
|
|
Gets a list containing the command instances for the specified command.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose instances are iterated through.
|
|
</param>
|
|
<returns>
|
|
A list containing the command instances for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetParameter``1(System.Windows.Input.KeyGesture,System.Windows.Input.ICommand)">
|
|
<summary>
|
|
Retrieves the command parameter to use based on the specified gesture and
|
|
command. This looks through all command instances and determines whether any of
|
|
them that instance the specified command have overridden the gesture and parameter
|
|
properties.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type that the command parameter should be returned in.
|
|
</typeparam>
|
|
<param name="gesture">
|
|
The gesture that should be associated with the retrieved parameter.
|
|
</param>
|
|
<param name="command">
|
|
The command object that should be associated with the retrieved parameter.
|
|
</param>
|
|
<returns>
|
|
The command parameter that is defined for the specified gesture and command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetToolbars">
|
|
<summary>
|
|
Retrieves a iterator over the collection of command tool bar items.
|
|
</summary>
|
|
<returns>
|
|
A iterator over the collection of command tool bar items.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.RegisterCommandAdded(RSG.Editor.IUserCreatedCommandBarItem)">
|
|
<summary>
|
|
Registers a command bar item has been added by the user to this manager.
|
|
</summary>
|
|
<param name="addedCommand">
|
|
The item that has been added.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.RegisterCommandRemoved(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Registers a command bar item has been removed by the user to this manager.
|
|
</summary>
|
|
<param name="removedCommand">
|
|
The item that has been removed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.SerialiseCommands(System.Xml.XmlWriter,System.IFormatProvider)">
|
|
<summary>
|
|
Serialises the commands into the specified xml writer.
|
|
</summary>
|
|
<param name="writer">
|
|
The xml writer that the commands gets serialised out to.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.AddCommandBarItem(RSG.Editor.CommandBarItem,System.Boolean)">
|
|
<summary>
|
|
Adds the specified item into the collection of managed command bar items.
|
|
</summary>
|
|
<param name="item">
|
|
The item to add to the collection of managed command bar items.
|
|
</param>
|
|
<param name="checkRemovedItems">
|
|
A value indicating whether before the item is added it is checked against the
|
|
removed items id list.
|
|
</param>
|
|
<returns>
|
|
Returns the added command bar item if added successfully.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.CanTextBoxCopy(System.Object,System.Windows.Input.CanExecuteRoutedEventArgs)">
|
|
<summary>
|
|
Determines whether RockstarCommands.Copy command can be fired from the current
|
|
position.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.CanTextBoxCut(System.Object,System.Windows.Input.CanExecuteRoutedEventArgs)">
|
|
<summary>
|
|
Determines whether RockstarCommands.Cut command can be fired from the current
|
|
position.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.CanTextBoxDelete(System.Object,System.Windows.Input.CanExecuteRoutedEventArgs)">
|
|
<summary>
|
|
Determines whether RockstarCommands.Delete command can be fired from the current
|
|
position.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.CanTextBoxPaste(System.Object,System.Windows.Input.CanExecuteRoutedEventArgs)">
|
|
<summary>
|
|
Determines whether RockstarCommands.Paste command can be fired from the current
|
|
position.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.GetCommandById(System.Guid)">
|
|
<summary>
|
|
Retrieves the command bar item instance with the specified id if found; otherwise,
|
|
null.
|
|
</summary>
|
|
<param name="id">
|
|
The id of the command bar item to retrieve.
|
|
</param>
|
|
<returns>
|
|
The command bar item instance with the specified id if found; otherwise, null.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.HandleModifications(RSG.Editor.CommandBarItem,RSG.Editor.RockstarCommandManager.ModificationContainer)">
|
|
<summary>
|
|
Handles the modifications that have been set on for the specified item.
|
|
</summary>
|
|
<param name="item">
|
|
The command bar item to setup the modifications on.
|
|
</param>
|
|
<param name="container">
|
|
The container where the modification values will be coming from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.OnTextBoxCopy(System.Object,System.Windows.Input.ExecutedRoutedEventArgs)">
|
|
<summary>
|
|
Called whenever the RockstarCommands.Copy command is fired and caught by a text
|
|
box.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.OnTextBoxCut(System.Object,System.Windows.Input.ExecutedRoutedEventArgs)">
|
|
<summary>
|
|
Called whenever the RockstarCommands.Cut command is fired and caught by a text
|
|
box.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.OnTextBoxDelete(System.Object,System.Windows.Input.ExecutedRoutedEventArgs)">
|
|
<summary>
|
|
Called whenever the RockstarCommands.Delete command is fired and caught by a text
|
|
box.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.OnTextBoxPaste(System.Object,System.Windows.Input.ExecutedRoutedEventArgs)">
|
|
<summary>
|
|
Called whenever the RockstarCommands.Paste command is fired and caught by a text
|
|
box.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The execute data that has been sent with the command.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.ResolveAddedCommands(System.Collections.Generic.IEnumerable{RSG.Editor.CommandDefinition})">
|
|
<summary>
|
|
Tries to set the command objects on all of the added commands that currently have
|
|
their command set to null.
|
|
</summary>
|
|
<param name="definitions">
|
|
The definitions to try and resolve off.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.ValidateCommandBarItem(RSG.Editor.CommandBarItem)">
|
|
<summary>
|
|
Validates the specified command bar item before it is added into this manager.
|
|
</summary>
|
|
<param name="commandItem">
|
|
The command bar item that is validated.
|
|
</param>
|
|
<returns>
|
|
True if the specified command item is valid and can be added to this manager;
|
|
otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.ValidateCommandDefinition(RSG.Editor.CommandDefinition)">
|
|
<summary>
|
|
Validates the specified command definition before it is added into this manager.
|
|
</summary>
|
|
<param name="definition">
|
|
The command definition that is validated.
|
|
</param>
|
|
<returns>
|
|
True if the specified command definition is valid and can be added to this manager;
|
|
otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.StateInfomation">
|
|
<summary>
|
|
A structure containing the information needed to deserialise the state for a
|
|
command definition.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandManager.StateInfomation._data">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.RockstarCommandManager.StateInfomation.Data"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.StateInfomation.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandManager.StateInfomation"/> structure.
|
|
</summary>
|
|
<param name="data">
|
|
The xml data that contains the stat information.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.RockstarCommandManager.StateInfomation.Data">
|
|
<summary>
|
|
Gets the xml data for this state.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.ProjectTopLevelMenu">
|
|
<summary>
|
|
Represents a menu that is positioned on the main menu that represents the "Project"
|
|
menu. This class cannot be inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.ProjectTopLevelMenu.#ctor(System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandManager.ProjectTopLevelMenu"/> class.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.ViewTopLevelMenu">
|
|
<summary>
|
|
Represents a menu that is positioned on the main menu that represents the "View"
|
|
menu. This class cannot be inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.ViewTopLevelMenu.#ctor(System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandManager.ViewTopLevelMenu"/> class.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.ActionsTopLevelMenu">
|
|
<summary>
|
|
Represents a menu that is positioned on the main menu that represents the "Actions"
|
|
menu. This class cannot be inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.ActionsTopLevelMenu.#ctor(System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandManager.ActionsTopLevelMenu"/> class.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.EditTopLevelMenu">
|
|
<summary>
|
|
Represents a menu that is positioned on the main menu that represents the "Edit"
|
|
menu. This class cannot be inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.EditTopLevelMenu.#ctor(System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandManager.EditTopLevelMenu"/> class.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.FileTopLevelMenu">
|
|
<summary>
|
|
Represents a menu that is positioned on the main menu that represents the "File"
|
|
menu. This class cannot be inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.FileTopLevelMenu.#ctor(System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandManager.FileTopLevelMenu"/> class.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.HelpTopLevelMenu">
|
|
<summary>
|
|
Represents a menu that is positioned on the main menu that represents the "Help"
|
|
menu. This class cannot be inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandManager.HelpTopLevelMenu.#ctor(System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandManager.HelpTopLevelMenu"/> class.
|
|
</summary>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.ModificationContainer">
|
|
<summary>
|
|
Represents a collection of command GUID values and their modification values.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandManager.ModificationFieldValue">
|
|
<summary>
|
|
Represents a collection of modification fields and their values.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ExecuteCommandData">
|
|
<summary>
|
|
Provides data for a method that implements a command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ExecuteCommandData._continueRouting">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ExecuteCommandData.ContinueRouting"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ExecuteCommandData._handled">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ExecuteCommandData.Handled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ExecuteCommandData.#ctor(System.Windows.Input.ICommand)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ExecuteCommandData"/> class based on
|
|
the specified command being invoked.
|
|
</summary>
|
|
<param name="command">
|
|
The command that was invoked.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ExecuteCommandData.ContinueRouting">
|
|
<summary>
|
|
Gets or sets a value indicating whether the input routed event that invoked the
|
|
command should continue to route through the element tree.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ExecuteCommandData.Handled">
|
|
<summary>
|
|
Gets or sets a value indicating whether the routed event has been handled somewhere
|
|
as it travels the element tree.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ExecuteCommandData`1">
|
|
<summary>
|
|
Provides data for a method that implements a command based on a parameter of the
|
|
specified type.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter used during the execution of the command.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.ExecuteCommandData`1._originalParameterWasNull">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ExecuteCommandData`1.OriginalParameterWasNull"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ExecuteCommandData`1._parameter">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ExecuteCommandData`1.Parameter"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ExecuteCommandData`1.#ctor(System.Windows.Input.ICommand,`0)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ExecuteCommandData`1"/> class based
|
|
on the specified command being invoked with the specified parameter.
|
|
</summary>
|
|
<param name="command">
|
|
The command that was invoked.
|
|
</param>
|
|
<param name="parameter">
|
|
The data parameter of the command.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ExecuteCommandData`1.OriginalParameterWasNull">
|
|
<summary>
|
|
Gets a value indicating whether the parameter passed in from the source event data
|
|
was set to null or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ExecuteCommandData`1.Parameter">
|
|
<summary>
|
|
Gets the data parameter that was sent with the invoked command.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ExecuteCommandException">
|
|
<summary>
|
|
Represents errors that occur during the execution of a command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ExecuteCommandException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ExecuteCommandException"/> class using
|
|
the default message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ExecuteCommandException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ExecuteCommandException"/> class with
|
|
the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ExecuteCommandException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ExecuteCommandException"/> class with
|
|
the specified inner exception and the default message.
|
|
</summary>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ExecuteCommandException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ExecuteCommandException"/> class with
|
|
the specified message and inner exception.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ExecuteCommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ExecuteCommandException"/> class with
|
|
serialised data.
|
|
</summary>
|
|
<param name="info">
|
|
The System.Runtime.Serialization.SerializationInfo that holds the serialised
|
|
object data about the exception being thrown.
|
|
</param>
|
|
<param name="context">
|
|
The System.Runtime.Serialization.StreamingContext that contains contextual
|
|
information about the source or destination.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.ExecuteCommandDelegate">
|
|
<summary>
|
|
Represents the method that will handle the implementation of a command.
|
|
</summary>
|
|
<param name="e">
|
|
The object containing the data to use inside the implementation method.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.ExecuteCommandDelegate`1">
|
|
<summary>
|
|
Represents the method that will handle the implementation of a command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the command parameter contained within the specified data.
|
|
</typeparam>
|
|
<param name="e">
|
|
The object containing the data to use inside the implementation method.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.SharedCommands.CommandResourceManager">
|
|
<summary>
|
|
A resource manager purposely built for dealing with a StringTable containing command
|
|
related strings. This class cannot be inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.#ctor(System.String,System.Reflection.Assembly)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SharedCommands.CommandResourceManager"/> class.
|
|
</summary>
|
|
<param name="baseName">
|
|
The root name of the resource file without its extension but including any fully
|
|
qualified namespace name.
|
|
</param>
|
|
<param name="assembly">
|
|
The main assembly for the resources.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.GetCategory(System.String)">
|
|
<summary>
|
|
Retrieves the category string value for the command with the specified id.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command whose category should be retrieved.
|
|
</param>
|
|
<returns>
|
|
The category value for the command with the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.GetDescription(System.String)">
|
|
<summary>
|
|
Retrieves the description string value for the command with the specified id.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command whose description should be retrieved.
|
|
</param>
|
|
<returns>
|
|
The description value for the command with the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.GetGestures(System.String)">
|
|
<summary>
|
|
Creates a System.Windows.InputGestureCollection object that contains the default
|
|
input gestures for the command with the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command whose default gestures should be created.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.InputGestureCollection object that contains the default input
|
|
gestures for the command with the specified identifier.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.GetName(System.String)">
|
|
<summary>
|
|
Retrieves the name string value for the command with the specified id.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command whose name should be retrieved.
|
|
</param>
|
|
<returns>
|
|
The name value for the command with the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.GetString(System.String)">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<returns>
|
|
The embedded string resource indexed by the specified identifier.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.GetString(System.String,RSG.Editor.SharedCommands.CommandStringCategory)">
|
|
<summary>
|
|
Retrieves the specified string value for the command with the specified id from
|
|
the command string table.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command whose string value should be retrieved.
|
|
</param>
|
|
<param name="category">
|
|
Specifies which string value to retrieve.</param>
|
|
<returns>
|
|
The specified string value for the command with the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.GetString(System.String,System.String[])">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier
|
|
formatted with the specified arguments.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<param name="args">
|
|
An object array that contains zero or more objects to format.
|
|
</param>
|
|
<returns>
|
|
The embedded string resource indexed by the specified identifier in which the
|
|
format items have been replaced by the string representations of the corresponding
|
|
objects in <paramref name="args"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.CommandResourceManager.TryToGetString(System.String,System.Globalization.CultureInfo)">
|
|
<summary>
|
|
Retrieves the embedded string resource indexed by the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the embedded string resource to retrieve.
|
|
</param>
|
|
<param name="cultureInfo">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
<returns>
|
|
A structure containing the result of the operation and a value indicating whether
|
|
the resource was successfully located.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.SharedCommands.CommandStringCategory">
|
|
<summary>
|
|
Defines the different string values a command has that can be retrieved from the
|
|
string table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.CommandStringCategory.Name">
|
|
<summary>
|
|
Defines the name string value located in the string table as {id}Name.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.CommandStringCategory.KeyGestures">
|
|
<summary>
|
|
Defines the description string value located in the string table as
|
|
{id}KeyGestures.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.CommandStringCategory.Category">
|
|
<summary>
|
|
Defines the category string value located in the string table as {id}Category.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.CommandStringCategory.Description">
|
|
<summary>
|
|
Defines the description string value located in the string table as
|
|
{id}Description.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SharedCommands.RockstarViewCommands">
|
|
<summary>
|
|
Defines core view commands for any Rockstar C#/WPF application. This class cannot be
|
|
inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands._internalCommands">
|
|
<summary>
|
|
The private cache of System.Windows.Input.RoutedCommand objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarViewCommands.#ctor">
|
|
<summary>
|
|
Prevents a default instance of the <see cref="T:RSG.Editor.SharedCommands.RockstarViewCommands"/> class from
|
|
being created.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId">
|
|
<summary>
|
|
Defines all of the command identifiers for the different core Rockstar commands.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.CancelDialog">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarViewCommands.CancelDialog"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.CloseWindow">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarViewCommands.CloseWindow"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.ConfirmDialog">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarViewCommands.ConfirmDialog"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.MinimiseWindow">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarViewCommands.MinimiseWindow"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.MaximiseWindow">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarViewCommands.MaximiseWindow"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.RestoreWindow">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarViewCommands.RestoreWindow"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.ShowHelpFromTitleBar">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarViewCommands.ShowHelpFromTitleBar"/>
|
|
routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.ShowOptionsFromTitleBar">
|
|
<summary>
|
|
Used to identifier the
|
|
<see cref="P:RSG.Editor.SharedCommands.RockstarViewCommands.ShowOptionsFromTitleBar"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarViewCommands.CommandId.CommandCount">
|
|
<summary>
|
|
Defines the number of commands defined as view commands for a Rockstar
|
|
application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarViewCommands.CancelDialog">
|
|
<summary>
|
|
Gets the value that represents the Cancel Dialog command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarViewCommands.CloseWindow">
|
|
<summary>
|
|
Gets the value that represents the Close Window command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarViewCommands.ConfirmDialog">
|
|
<summary>
|
|
Gets the value that represents the Confirm Dialog command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarViewCommands.MaximiseWindow">
|
|
<summary>
|
|
Gets the value that represents the Maximize Window command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarViewCommands.MinimiseWindow">
|
|
<summary>
|
|
Gets the value that represents the Minimize Window command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarViewCommands.RestoreWindow">
|
|
<summary>
|
|
Gets the value that represents the Restore Window command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarViewCommands.ShowHelpFromTitleBar">
|
|
<summary>
|
|
Gets the value that represents the Show Help From TitleBar command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarViewCommands.ShowOptionsFromTitleBar">
|
|
<summary>
|
|
Gets the value that represents the Show Options From TitleBar command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarViewCommands.CreateCommand(RSG.Editor.SharedCommands.RockstarViewCommands.CommandId)">
|
|
<summary>
|
|
Creates a new System.Windows.Input.RoutedCommand object that is associated with the
|
|
specified identifier.
|
|
</summary>
|
|
<param name="commandId">
|
|
The identifier for the command to create.
|
|
</param>
|
|
<returns>
|
|
The newly create System.Windows.Input.RoutedCommand object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarViewCommands.EnsureCommandExists(RSG.Editor.SharedCommands.RockstarViewCommands.CommandId)">
|
|
<summary>
|
|
Makes sure the internal value for the command associated with the specified
|
|
identifier exists and returns it.
|
|
</summary>
|
|
<param name="commandId">
|
|
The identifier for the command that should be created and returned.
|
|
</param>
|
|
<returns>
|
|
The System.Windows.Input.RoutedCommand object associated with the specified
|
|
identifier.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarViewCommands.GetName(RSG.Editor.SharedCommands.RockstarViewCommands.CommandId)">
|
|
<summary>
|
|
Get the name that corresponds to the specified command id.
|
|
</summary>
|
|
<param name="commandId">
|
|
The command id whose name should be retrieved.
|
|
</param>
|
|
<returns>
|
|
The corresponding name for the specified command id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarViewCommands.InitialiseInternalStorage">
|
|
<summary>
|
|
Initialises the array used to store the System.Windows.Input.RoutedCommand objects
|
|
that make up the core commands for a Rockstar application.
|
|
</summary>
|
|
<returns>
|
|
The array used to store the internal System.Windows.Input.RoutedCommand objects.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.SharedCommands.RockstarCommands">
|
|
<summary>
|
|
Defines core commands for any Rockstar C#/WPF application. This class cannot be
|
|
inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands._internalCommands">
|
|
<summary>
|
|
The private cache of command objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarCommands.#ctor">
|
|
<summary>
|
|
Prevents a default instance of the <see cref="T:RSG.Editor.SharedCommands.RockstarCommands"/> class from being
|
|
created.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SharedCommands.RockstarCommands.Id">
|
|
<summary>
|
|
Defines all of the command identifiers for the different core Rockstar commands.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Close">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Close"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Collapse">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Collapse"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.CollapseAll">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.CollapseAll"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Copy">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Copy"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Cut">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Cut"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Delete">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Delete"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Exit">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Exit"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Expand">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Expand"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.ExpandAll">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.ExpandAll"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Find">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Find"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.FindInFiles">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.FindInFiles"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.FindNext">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.FindNext"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.FindPrevious">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.FindPrevious"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.InvertSelection">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.InvertSelection"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.NewFile">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.NewFile"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.OpenFile">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.OpenFile"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.OpenFileFromMru">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.OpenFileFromMru"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.OpenProjectFromMru">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.OpenProjectFromMru"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Paste">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Paste"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.QuickFind">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.QuickFind"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.QuickReplace">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.QuickReplace"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Redo">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Redo"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Rename">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Rename"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.ReplaceInFiles">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.ReplaceInFiles"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.ReportBug">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.ReportBug"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Restart">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Restart"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Save">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Save"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.SaveAll">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.SaveAll"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.SaveAs">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.SaveAs"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.SelectAll">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.SelectAll"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.ShellExecute">
|
|
<summary>
|
|
Used to identify the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.ShellExecute"/> routed
|
|
command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.Undo">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.Undo"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.ViewAbout">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.ViewAbout"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.ViewHelp">
|
|
<summary>
|
|
Used to identifier the <see cref="P:RSG.Editor.SharedCommands.RockstarCommands.ViewHelp"/> routed command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.Id.CommandCount">
|
|
<summary>
|
|
Defines the number of commands defined as core commands for a Rockstar
|
|
application.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SharedCommands.RockstarCommands.StringValue">
|
|
<summary>
|
|
Defines the different string values a command has that can be retrieved from the
|
|
string table.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.StringValue.Category">
|
|
<summary>
|
|
Defines the category string value located in the string table as
|
|
{id}Category.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.StringValue.Description">
|
|
<summary>
|
|
Defines the description string value located in the string table as
|
|
{id}Description.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.StringValue.KeyGestures">
|
|
<summary>
|
|
Defines the description string value located in the string table as
|
|
{id}KeyGestures.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SharedCommands.RockstarCommands.StringValue.Name">
|
|
<summary>
|
|
Defines the name string value located in the string table as
|
|
{id}Name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Close">
|
|
<summary>
|
|
Gets the value that represents the Close command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Collapse">
|
|
<summary>
|
|
Gets the value that represents the Collapse command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.CollapseAll">
|
|
<summary>
|
|
Gets the value that represents the Collapse All command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Copy">
|
|
<summary>
|
|
Gets the value that represents the Copy command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Cut">
|
|
<summary>
|
|
Gets the value that represents the Cut command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Delete">
|
|
<summary>
|
|
Gets the value that represents the Delete command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Exit">
|
|
<summary>
|
|
Gets the value that represents the Exit command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Expand">
|
|
<summary>
|
|
Gets the value that represents the Expand command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.ExpandAll">
|
|
<summary>
|
|
Gets the value that represents the Expand All command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Find">
|
|
<summary>
|
|
Gets the value that represents the Find command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.FindInFiles">
|
|
<summary>
|
|
Gets the value that represents the Find In Files command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.FindNext">
|
|
<summary>
|
|
Gets the value that represents the Find Next command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.FindPrevious">
|
|
<summary>
|
|
Gets the value that represents the Find Previous command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.InvertSelection">
|
|
<summary>
|
|
Gets the value that represents the Invert Selection command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.NewFile">
|
|
<summary>
|
|
Gets the value that represents the New File command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.OpenFile">
|
|
<summary>
|
|
Gets the value that represents the Open File command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.OpenFileFromMru">
|
|
<summary>
|
|
Gets the value that represents theOpen File From MRU command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.OpenProjectFromMru">
|
|
<summary>
|
|
Gets the value that represents the Open Project From MRU command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Paste">
|
|
<summary>
|
|
Gets the value that represents the Paste command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.QuickFind">
|
|
<summary>
|
|
Gets the value that represents the Quick Find command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.QuickReplace">
|
|
<summary>
|
|
Gets the value that represents the Quick Replace command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Redo">
|
|
<summary>
|
|
Gets the value that represents the Redo command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Rename">
|
|
<summary>
|
|
Gets the value that represents the Rename command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.ReplaceInFiles">
|
|
<summary>
|
|
Gets the value that represents the Replace In Files command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.ReportBug">
|
|
<summary>
|
|
Gets the value that represents the Report Bug command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Restart">
|
|
<summary>
|
|
Gets the value that represents the Restart command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Save">
|
|
<summary>
|
|
Gets the value that represents the Save command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.SaveAll">
|
|
<summary>
|
|
Gets the value that represents the Save All command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.SaveAs">
|
|
<summary>
|
|
Gets the value that represents the Save As command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.SelectAll">
|
|
<summary>
|
|
Gets the value that represents the Select All command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.ShellExecute">
|
|
<summary>
|
|
Gets the value that represents the Shell Execute command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.Undo">
|
|
<summary>
|
|
Gets the value that represents the Undo command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.ViewAbout">
|
|
<summary>
|
|
Gets the value that represents the View About command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SharedCommands.RockstarCommands.ViewHelp">
|
|
<summary>
|
|
Gets the value that represents the Help command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarCommands.CreateCommand(System.String,System.Windows.Media.Imaging.BitmapSource)">
|
|
<summary>
|
|
Creates a new <see cref="T:RSG.Editor.RockstarRoutedCommand"/> object that is
|
|
associated with the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command to create.
|
|
</param>
|
|
<param name="icon">
|
|
The icon that the created command should be using.
|
|
</param>
|
|
<returns>
|
|
The newly created <see cref="T:RSG.Editor.RockstarRoutedCommand"/> object.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarCommands.EnsureCommandExists(RSG.Editor.SharedCommands.RockstarCommands.Id)">
|
|
<summary>
|
|
Makes sure the internal value for the command associated with the specified
|
|
identifier exists and returns it.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command that should be created and returned.
|
|
</param>
|
|
<returns>
|
|
The <see cref="T:RSG.Editor.RockstarRoutedCommand"/> object associated with the
|
|
specified identifier.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarCommands.EnsureCommandExists(RSG.Editor.SharedCommands.RockstarCommands.Id,System.Windows.Media.Imaging.BitmapSource)">
|
|
<summary>
|
|
Makes sure the internal value for the command associated with the specified
|
|
identifier exists and returns it.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command that should be created and returned.
|
|
</param>
|
|
<param name="icon">
|
|
The icon that the command should be using.
|
|
</param>
|
|
<returns>
|
|
The <see cref="T:RSG.Editor.RockstarRoutedCommand"/> object associated with the
|
|
specified identifier.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarCommands.GetGestures(System.String)">
|
|
<summary>
|
|
Creates a System.Windows.InputGestureCollection object that contains the default
|
|
input gestures for the command with the specified identifier.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command whose default gestures should be created.
|
|
</param>
|
|
<returns>
|
|
A System.Windows.InputGestureCollection object that contains the default input
|
|
gestures for the command with the specified identifier.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarCommands.GetName(System.String)">
|
|
<summary>
|
|
Retrieves the name string value for the command with the specified id.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command whose name should be retrieved.
|
|
</param>
|
|
<returns>
|
|
The name value for the command with the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarCommands.GetStringValue(System.String,RSG.Editor.SharedCommands.RockstarCommands.StringValue)">
|
|
<summary>
|
|
Retrieves the specified string value for the command with the specified id from
|
|
the command string table.
|
|
</summary>
|
|
<param name="id">
|
|
The identifier for the command whose string value should be retrieved.
|
|
</param>
|
|
<param name="value">
|
|
Specifies which string value to retrieve.
|
|
</param>
|
|
<returns>
|
|
The specified string value for the command with the specified id.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SharedCommands.RockstarCommands.InitialiseInternalStorage">
|
|
<summary>
|
|
Initialises the array used to store the System.Windows.Input.RoutedCommand objects
|
|
that make up the core commands for a Rockstar application.
|
|
</summary>
|
|
<returns>
|
|
The array used to store the internal System.Windows.Input.RoutedCommand objects.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.SearchCommand">
|
|
<summary>
|
|
Provides a base class to a definition of a search command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchCommand._canFilterResults">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchCommand.CanFilterResults"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchCommand._canUseMatchCase">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchCommand.CanUseMatchCase"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchCommand._canUseMatchWholeWord">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchCommand.CanUseMatchWholeWord"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchCommand._canUseRegularExpressions">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchCommand.CanUseRegularExpressions"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchCommand._scopes">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchCommand.Scopes"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchCommand.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SearchCommand"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchCommand.CanFilterResults">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can filter the view to just show
|
|
the search results.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchCommand.CanUseMatchCase">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can search with case sensitivity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchCommand.CanUseMatchWholeWord">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can search for whole words.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchCommand.CanUseRegularExpressions">
|
|
<summary>
|
|
Gets or sets a value indicating whether the user can search using regular
|
|
expressions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchCommand.CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchCommand.RSG#Editor#ICommandWithParameter#CommandParameter">
|
|
<summary>
|
|
Gets the parameter that is routed through the element tree with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchCommand.Scopes">
|
|
<summary>
|
|
Gets the collection defining the different scopes the user can search in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchCommand.SearchDelay">
|
|
<summary>
|
|
Gets the delay in milliseconds between the user typing and the search taking place.
|
|
Use 0 or less to indicating no delay and int.MaxValue to indicate the user has to
|
|
press a button to search.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SearchData">
|
|
<summary>
|
|
Represents the data that is sent as the command parameter for a search command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchData._cleared">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchData.Cleared"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchData._cancellationTokenSource">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchData.CancellationTokenSource"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchData._filteringResults">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchData.FilteringResults"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchData._matchCase">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchData.MatchCase"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchData._matchWord">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchData.MatchWord"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchData._regularExpressions">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchData.RegularExpressions"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchData._searchText">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchData.SearchText"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchData.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SearchData"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.SearchData.GeneralErrorDetected">
|
|
<summary>
|
|
Occurs when a general error has been detected during the current search.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.SearchData.ParseErrorDetected">
|
|
<summary>
|
|
Occurs when a parsing error has been detected within the current search text.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.SearchData.SearchFinished">
|
|
<summary>
|
|
Occurs when the current search has finished.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.SearchData.SearchStarting">
|
|
<summary>
|
|
Occurs when a new search is just about to be started.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchData.Cleared">
|
|
<summary>
|
|
Gets a value indicating whether the search has been cleared.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchData.FilteringResults">
|
|
<summary>
|
|
Gets a value indicating whether the search described by this data class should
|
|
filter the user interface so that only the valid search results are shown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchData.MatchCase">
|
|
<summary>
|
|
Gets a value indicating whether the search described by this data class is case
|
|
sensitive or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchData.MatchWord">
|
|
<summary>
|
|
Gets a value indicating whether the search described by this data class should
|
|
match the whole word or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchData.RegularExpressions">
|
|
<summary>
|
|
Gets a value indicating whether the search described by this data class can be
|
|
using regular expressions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchData.SearchText">
|
|
<summary>
|
|
Gets the actual string that should be searched for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchData.CancellationTokenSource">
|
|
<summary>
|
|
Gets or sets the cancellation token source that is used to cancel the search.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchData.RegisterError(System.String)">
|
|
<summary>
|
|
Registers that there has been a general error with the search and specifies a
|
|
message to display to the user.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchData.RegisterParseError(System.String)">
|
|
<summary>
|
|
Registers that there has been a parsing error with the search text and specifies a
|
|
message to display to the user.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the parsing error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchData.RegisterSearchFinished(System.Boolean)">
|
|
<summary>
|
|
Registers that the search has finished successfully.
|
|
</summary>
|
|
<param name="foundResults">
|
|
A value indicating whether any results have been found during the search.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchData.RegisterSearchStarting">
|
|
<summary>
|
|
Registers that the search is about to start.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchData.ThrowIfCancellationRequested">
|
|
<summary>
|
|
Throws a System.OperationCancelledException if the search has been cancelled.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SearchErrorEventArgs">
|
|
<summary>
|
|
Represents the class containing the data for a error event during a search command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchErrorEventArgs._message">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchErrorEventArgs.Message"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchErrorEventArgs._parsingError">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchErrorEventArgs.ParsingError"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchErrorEventArgs.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SearchErrorEventArgs"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchErrorEventArgs.Message">
|
|
<summary>
|
|
Gets or sets the message that describes the error that has been generated.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchErrorEventArgs.ParsingError">
|
|
<summary>
|
|
Gets or sets a value indicating whether the error this data is describing is
|
|
actually a parsing error.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SearchFinishedEventArgs">
|
|
<summary>
|
|
Represents the class containing the data for the event when a search finishes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.SearchFinishedEventArgs._foundEntries">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.SearchFinishedEventArgs.FoundEntries"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SearchFinishedEventArgs.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SearchFinishedEventArgs"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.SearchFinishedEventArgs.FoundEntries">
|
|
<summary>
|
|
Gets or sets a value indicating whether any entries have been found during the
|
|
search.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.SimpleFunctionDelegate">
|
|
<summary>
|
|
Encapsulates a method that has no parameters and returns a generic object.
|
|
</summary>
|
|
<returns>
|
|
The return value of the method that this delegate encapsulates.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.NotifyPropertyChangedBase">
|
|
<summary>
|
|
Provides a abstract class that can be inherited by classes that wish to implement the
|
|
System.ComponentModel.INotifyPropertyChanged interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.NotifyPropertyChangedBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.NotifyPropertyChangedBase.PropertyChanged">
|
|
<summary>
|
|
Occurs when a property value changes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.NotifyPropertyChanged(System.String[])">
|
|
<summary>
|
|
Fires the property changed event for the specified property names.
|
|
</summary>
|
|
<param name="names">
|
|
A array of property names that have been changed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.NotifyPropertyChanged(System.String)">
|
|
<summary>
|
|
Fires the property changed event for the specified property names.
|
|
</summary>
|
|
<param name="name">
|
|
The name of the property that has been changed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.NotifyPropertyChanged(System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Fires the property changed event for the specified property names.
|
|
</summary>
|
|
<param name="names">
|
|
A iterator around all of property names that are changed due to this one change.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.SetProperty``1(``0@,``0,System.String)">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="name">
|
|
The name of the property that has been changed.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.SetProperty``1(``0@,``0,System.Collections.Generic.IEqualityComparer{``0},System.String)">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="comparer">
|
|
The equality comparer to use to determine whether the value has changed.
|
|
</param>
|
|
<param name="name">
|
|
The name of the property that has been changed.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.SetProperty``1(``0@,``0,System.String[])">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="names">
|
|
An array of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.SetProperty``1(``0@,``0,System.Collections.Generic.IEqualityComparer{``0},System.String[])">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="comparer">
|
|
The equality comparer to use to determine whether the value has changed.
|
|
</param>
|
|
<param name="names">
|
|
An array of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.SetProperty``1(``0@,``0,System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="names">
|
|
A iterator around all of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.NotifyPropertyChangedBase.SetProperty``1(``0@,``0,System.Collections.Generic.IEqualityComparer{``0},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Sets the given field to the given value making sure the correct property changed
|
|
event is fired.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the field that is getting set.
|
|
</typeparam>
|
|
<param name="field">
|
|
A reference to the field that is getting set.
|
|
</param>
|
|
<param name="value">
|
|
The value to set the field to.
|
|
</param>
|
|
<param name="comparer">
|
|
The equality comparer to use to determine whether the value has changed.
|
|
</param>
|
|
<param name="names">
|
|
A iterator around all of property names that are changed due to this one change.
|
|
</param>
|
|
<returns>
|
|
True if the property was changed; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandBinding">
|
|
<summary>
|
|
Binds a System.Window.Input.ICommand object to the handlers that determine whether the
|
|
command can be executed and what happens when it does get executed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandBinding._canExecuteHandler">
|
|
<summary>
|
|
The private reference to the handler who is responsible for determining whether the
|
|
command can be executed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandBinding._executeHandler">
|
|
<summary>
|
|
The private reference to the handler who is responsible for the implementation of
|
|
the command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandBinding._isAsync">
|
|
<summary>
|
|
A private value indicating whether this binding should be executed as a awaited
|
|
operation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding.#ctor(System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate,RSG.Editor.CanExecuteCommandDelegate)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command to base the new System.Windows.Input.RoutedCommand on.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding.#ctor(System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate,RSG.Editor.CanExecuteCommandDelegate,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command to base the new System.Windows.Input.RoutedCommand on.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
<param name="isAsync">
|
|
A value indicating whether this binding should be executed as a awaited operation.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding.WrapCanExecute(System.Object,System.Windows.Input.CanExecuteRoutedEventArgs)">
|
|
<summary>
|
|
Wraps the handler that is used to determine whether the command can be executed so
|
|
that a more focused argument object can be passed to the handler and exceptions can
|
|
be handled correctly.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The event data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding.WrapExecution(System.Object,System.Windows.Input.ExecutedRoutedEventArgs)">
|
|
<summary>
|
|
Wraps the implementation of the command so that a more focused argument object can
|
|
be passed to the handler, exceptions can be handled correctly, and threads can be
|
|
managed.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The event data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.RockstarCommandBinding`1">
|
|
<summary>
|
|
Binds a System.Window.Input.ICommand object to the handlers that determine whether the
|
|
command can be executed and what happens when it does get executed.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of command parameter that should be past into the execution and can execute
|
|
methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandBinding`1._canExecuteHandler">
|
|
<summary>
|
|
The private reference to the handler who is responsible for determining whether the
|
|
command can be executed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandBinding`1._executeHandler">
|
|
<summary>
|
|
The private reference to the handler who is responsible for the implementation of
|
|
the command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.RockstarCommandBinding`1._isAsync">
|
|
<summary>
|
|
A private value indicating whether this binding should be executed as a awaited
|
|
operation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding`1.#cctor">
|
|
<summary>
|
|
Initialises static members of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding`1.#ctor(System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{`0},RSG.Editor.CanExecuteCommandDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command to base the new System.Windows.Input.RoutedCommand on.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding`1.#ctor(System.Windows.Input.ICommand,RSG.Editor.ExecuteCommandDelegate{`0},RSG.Editor.CanExecuteCommandDelegate{`0},System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.RockstarCommandBinding`1"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The command to base the new System.Windows.Input.RoutedCommand on.
|
|
</param>
|
|
<param name="executeHandler">
|
|
The handler that gets called once the specified command is executed.
|
|
</param>
|
|
<param name="canExecuteHandler">
|
|
The handler that gets called to determine whether the command can be executed.
|
|
</param>
|
|
<param name="isAsync">
|
|
A value indicating whether this binding should be executed as a awaited operation.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding`1.ResolveCommandParameter(System.Windows.Input.KeyGesture,System.Object)">
|
|
<summary>
|
|
Converts the specified command parameter into a instance of this classes generic
|
|
type.
|
|
</summary>
|
|
<param name="gesture">
|
|
The key gesture that was used to fire the command.
|
|
</param>
|
|
<param name="rawParameter">
|
|
The command parameter that needs resolving.
|
|
</param>
|
|
<returns>
|
|
The command parameter that should be given to the can execute and execute
|
|
implementations.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding`1.WrapCanExecute(System.Object,System.Windows.Input.CanExecuteRoutedEventArgs)">
|
|
<summary>
|
|
Wraps the handler that is used to determine whether the command can be executed so
|
|
that a more focused argument object can be passed to the handler and exceptions can
|
|
be handled correctly.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The event data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.RockstarCommandBinding`1.WrapExecution(System.Object,System.Windows.Input.ExecutedRoutedEventArgs)">
|
|
<summary>
|
|
Wraps the implementation of the command so that a more focused argument object can
|
|
be passed to the handler, exceptions can be handled correctly, and threads can be
|
|
managed.
|
|
</summary>
|
|
<param name="sender">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The event data.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.SmartArgumentNullException">
|
|
<summary>
|
|
The exception that is thrown when a null reference is found in a public method that
|
|
doesn't expect it as a valid argument.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SmartArgumentNullException"/> class
|
|
using the default message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.#ctor(System.Linq.Expressions.Expression{RSG.Editor.SimpleFunctionDelegate})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SmartArgumentNullException"/> class
|
|
using the default
|
|
message.
|
|
</summary>
|
|
<param name="argument">
|
|
A reference to the argument that is null.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.#ctor(System.String)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SmartArgumentNullException"/> class
|
|
with the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.#ctor(System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SmartArgumentNullException"/> class
|
|
with the specified inner exception and the default message.
|
|
</summary>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.#ctor(System.Linq.Expressions.Expression{RSG.Editor.SimpleFunctionDelegate},System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SmartArgumentNullException"/> class
|
|
with the specified inner exception and the default message.
|
|
</summary>
|
|
<param name="argument">
|
|
A reference to the argument that is null.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SmartArgumentNullException"/> class
|
|
with the specified message and inner exception.
|
|
</summary>
|
|
<param name="message">
|
|
The message that describes the error.
|
|
</param>
|
|
<param name="innerException">
|
|
The exception that is the cause of this current exception, or a null reference if
|
|
no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.SmartArgumentNullException"/> class
|
|
with serialised data.
|
|
</summary>
|
|
<param name="info">
|
|
The System.Runtime.Serialization.SerializationInfo that holds the serialised
|
|
object data about the exception being thrown.
|
|
</param>
|
|
<param name="context">
|
|
The System.Runtime.Serialization.StreamingContext that contains contextual
|
|
information about the source or destination.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.GetMemberName(System.Linq.Expressions.Expression{RSG.Editor.SimpleFunctionDelegate})">
|
|
<summary>
|
|
Gets the name of the specified expressions body.
|
|
</summary>
|
|
<param name="expression">
|
|
The expression that the name will be returned for.
|
|
</param>
|
|
<returns>
|
|
The name of the specified expressions body.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.SmartArgumentNullException.GetMessage(System.Linq.Expressions.Expression{RSG.Editor.SimpleFunctionDelegate})">
|
|
<summary>
|
|
Gets the message to go with this exception.
|
|
</summary>
|
|
<param name="expression">
|
|
The argument whose name will be included in the message.
|
|
</param>
|
|
<returns>
|
|
The message to go with this exception.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.PerforceFileAction">
|
|
<summary>
|
|
Describes the pending or completed action related to open, resolve, or integration for
|
|
a specific file in source control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.None">
|
|
<summary>
|
|
No action.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Add">
|
|
<summary>
|
|
Opened for add.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Branch">
|
|
<summary>
|
|
Opened for branch.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Edit">
|
|
<summary>
|
|
Opened for edit.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Integrate">
|
|
<summary>
|
|
Opened for integrate.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Delete">
|
|
<summary>
|
|
File has been deleted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.DeleteFrom">
|
|
<summary>
|
|
File was integrated from partner-file, and partner-file had been previously
|
|
deleted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.DeleteInto">
|
|
<summary>
|
|
File was integrated into partner-file, and file had been previously deleted.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Sync">
|
|
<summary>
|
|
File has been synced.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Updated">
|
|
<summary>
|
|
File has been updated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Added">
|
|
<summary>
|
|
File has been added.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.AddInto">
|
|
<summary>
|
|
File was integrated into previously non existent partner-file, and partner-file was
|
|
reopened for add before submission.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Refreshed">
|
|
<summary>
|
|
File has been refreshed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Ignored">
|
|
<summary>
|
|
File was integrated from partner-file, accepting yours.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.IgnoredBy">
|
|
<summary>
|
|
File was integrated into partner-file, accepting yours.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Abandoned">
|
|
<summary>
|
|
File has been abandoned.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.EditIgnored">
|
|
<summary>
|
|
File has been edited and ignored.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Move">
|
|
<summary>
|
|
File is opened for move.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.MoveAdd">
|
|
<summary>
|
|
File has been added as part of a move.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.MoveDelete">
|
|
<summary>
|
|
File has been deleted as part of a move.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.MovedFrom">
|
|
<summary>
|
|
File was integrated from partner-file, accepting theirs and deleting the original.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.MovedInto">
|
|
<summary>
|
|
File was integrated into partner-file, accepting merge.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Unresolved">
|
|
<summary>
|
|
File has not been resolved.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.CopyFrom">
|
|
<summary>
|
|
File was integrated from partner-file, accepting theirs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.CopyInto">
|
|
<summary>
|
|
File was integrated into partner-file, accepting theirs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.MergeFrom">
|
|
<summary>
|
|
File was integrated from partner-file, accepting merge.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.MergeInto">
|
|
<summary>
|
|
File was integrated into partner-file, accepting merge.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.EditFrom">
|
|
<summary>
|
|
File was integrated from partner-file, and file was edited within the p4 resolve
|
|
process. This allows you to determine whether the change should ever be integrated
|
|
back; automated changes (merge from) needn't be, but original user edits (edit
|
|
from) performed during the resolve should be.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.EditInto">
|
|
<summary>
|
|
File was integrated into partner-file, and partner-file was reopened for edit
|
|
before submission.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Purge">
|
|
<summary>
|
|
File was purged.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Import">
|
|
<summary>
|
|
File was imported.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.BranchFrom">
|
|
<summary>
|
|
File did not previously exist; it was created as a copy of partner-file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.BranchInto">
|
|
<summary>
|
|
Partner-file did not previously exist; it was created as a copy of file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.PerforceFileAction.Reverted">
|
|
<summary>
|
|
File was reverted.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.ToggleButtonActionAsync`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a toggle button
|
|
command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter pass into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonActionAsync`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ToggleButtonActionAsync`1"/>
|
|
class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ToggleButtonActionAsync`1.IsToggled">
|
|
<summary>
|
|
Gets a value indicating whether state of the toggle command definition for the
|
|
currently executed routed command is toggled or not.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonActionAsync`1.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonActionAsync`1.GetInitialToggleState(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Determines what the initial toggle state for the definition to the specified
|
|
command is.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definitions toggle state is being set.
|
|
</param>
|
|
<returns>
|
|
The initial toggle state for the definition to the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonActionAsync`1.GetToggledIcon(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Retrieves the icon to use for the specified command in a toggled state if it's
|
|
different to the icon used in the un-toggled state.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definitions toggled icon is being set.
|
|
</param>
|
|
<returns>
|
|
The icon to use for the specified command in a toggled state.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ToggleButtonAction`1">
|
|
<summary>
|
|
Provides a abstract base class to any class that is used to implement a toggle button
|
|
command.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the parameter pass into the can execute and execute methods.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonAction`1.#ctor(RSG.Editor.ParameterResolverDelegate{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ToggleButtonAction`1"/> class.
|
|
</summary>
|
|
<param name="resolver">
|
|
The resolver that this class uses to obtain the command parameter from.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ToggleButtonAction`1.IsToggled">
|
|
<summary>
|
|
Gets a value indicating whether state of the toggle command definition for the
|
|
currently executed routed command is toggled or not.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonAction`1.CreateDefinition(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Create a new command definition for each command associated with this
|
|
implementation.
|
|
</summary>
|
|
<param name="command">
|
|
The command to create the definition for.
|
|
</param>
|
|
<returns>
|
|
The new command definition created for the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonAction`1.GetInitialToggleState(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Determines what the initial toggle state for the definition to the specified
|
|
command is.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definitions toggle state is being set.
|
|
</param>
|
|
<returns>
|
|
The initial toggle state for the definition to the specified command.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonAction`1.GetToggledIcon(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Retrieves the icon to use for the specified command in a toggled state if it's
|
|
different to the icon used in the un-toggled state.
|
|
</summary>
|
|
<param name="command">
|
|
The command whose definitions toggled icon is being set.
|
|
</param>
|
|
<returns>
|
|
The icon to use for the specified command in a toggled state.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.ToggleButtonCommand">
|
|
<summary>
|
|
Provides a base class to a definition of a button command.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ToggleButtonCommand._isToggled">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ToggleButtonCommand.IsToggled"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ToggleButtonCommand._toggledIcon">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ToggleButtonCommand.ToggledIcon"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonCommand.#ctor(RSG.Editor.RockstarRoutedCommand,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ToggleButtonCommand"/> class.
|
|
</summary>
|
|
<param name="command">
|
|
The <see cref="T:RSG.Editor.RockstarRoutedCommand"/> that this definition is
|
|
representing.
|
|
</param>
|
|
<param name="isToggled">
|
|
A value indicating the initial toggle state for this command definition.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ToggleButtonCommand.Icon">
|
|
<summary>
|
|
Gets the System.Windows.Media.Imaging.BitmapSource object that represents the icon
|
|
that is used for this command, this can be null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ToggleButtonCommand.IsToggled">
|
|
<summary>
|
|
Gets or sets a value indicating whether this definition is currently in the toggled
|
|
state or not.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ToggleButtonCommand.ToggledIcon">
|
|
<summary>
|
|
Gets or sets the System.Windows.Media.Imaging.BitmapSource object that represents
|
|
the icon that is used for this command when it is toggled, this can be null.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonCommand.DeserialiseState(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Deserialises the commands state using the data contained within the specified xml
|
|
reader.
|
|
</summary>
|
|
<param name="reader">
|
|
The xml reader that contains the state data.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
<returns>
|
|
A value indicating whether the command needs to be executed due to the
|
|
de-serialisation process.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonCommand.SerialiseState(System.Xml.XmlWriter,System.IFormatProvider)">
|
|
<summary>
|
|
Serialises the state of this definition into the specified xml writer.
|
|
</summary>
|
|
<param name="writer">
|
|
The xml writer that the state gets serialised out to.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.ToggleButtonCommand.OnIsToggledChanged">
|
|
<summary>
|
|
Override to handle the event that this definitions <see cref="P:RSG.Editor.ToggleButtonCommand.IsToggled"/> flag
|
|
changes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.TopLevelMenu">
|
|
<summary>
|
|
Represents a menu that is positioned on the main menu.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.TopLevelMenu.#ctor(System.UInt16,System.String,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.TopLevelMenu"/> class.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="text">
|
|
The text for this command bar item.
|
|
</param>
|
|
<param name="id">
|
|
The unique identifier that is used to reference this item.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.UserCreateCommandMenu">
|
|
<summary>
|
|
A class that represents a command menu that has been created by the user during
|
|
customisation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreateCommandMenu.#ctor(System.UInt16,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.UserCreateCommandMenu"/> class.
|
|
</summary>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreateCommandMenu.#ctor(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.UserCreateCommandMenu"/> class
|
|
using the specified reader as a data provider.
|
|
</summary>
|
|
<param name="reader">
|
|
The reader to use as a data provider.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreateCommandMenu.SerialiseCommand(System.Xml.XmlWriter,System.IFormatProvider)">
|
|
<summary>
|
|
Serialises this command to the end of the specified writer.
|
|
</summary>
|
|
<param name="writer">
|
|
The xml writer that the command gets serialised out to.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreateCommandMenu.DeserialiseCommand(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Deserialises the command using the data contained within the specified xml reader.
|
|
</summary>
|
|
<param name="reader">
|
|
The xml reader that contains the command data.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.UserCreateCommandToolbar">
|
|
<summary>
|
|
A class that represents a command toolbar that has been created by the user during
|
|
customisation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreateCommandToolbar.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.UserCreateCommandToolbar"/> class..
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreateCommandToolbar.#ctor(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.UserCreateCommandToolbar"/> class
|
|
using the specified reader as a data provider.
|
|
</summary>
|
|
<param name="reader">
|
|
The reader to use as a data provider.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreateCommandToolbar.SerialiseCommand(System.Xml.XmlWriter,System.IFormatProvider)">
|
|
<summary>
|
|
Serialises this command to the end of the specified writer.
|
|
</summary>
|
|
<param name="writer">
|
|
The xml writer that the command gets serialised out to.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreateCommandToolbar.DeserialiseCommand(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Deserialises the command using the data contained within the specified xml reader.
|
|
</summary>
|
|
<param name="reader">
|
|
The xml reader that contains the command data.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.UserCreatedCommandInstance">
|
|
<summary>
|
|
A class that represents a command instance that has been created by the user during
|
|
customisation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.UserCreatedCommandInstance._commandName">
|
|
<summary>
|
|
The private field containing the name of the command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreatedCommandInstance.#ctor(RSG.Editor.CommandDefinition,System.UInt16,System.Guid)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.UserCreatedCommandInstance"/> class
|
|
using the specified command definition as a root.
|
|
</summary>
|
|
<param name="definition">
|
|
The definition that this command instance is to be instancing.
|
|
</param>
|
|
<param name="priority">
|
|
The initial priority that this command bar item should be given.
|
|
</param>
|
|
<param name="parentId">
|
|
The unique identifier for the parent of this item inside the command bar hierarchy.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreatedCommandInstance.#ctor(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.UserCreatedCommandInstance"/> class
|
|
using the specified reader as a data provider.
|
|
</summary>
|
|
<param name="reader">
|
|
The reader to use as a data provider.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.UserCreatedCommandInstance.CommandName">
|
|
<summary>
|
|
Gets the name associated with the command.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreatedCommandInstance.SerialiseCommand(System.Xml.XmlWriter,System.IFormatProvider)">
|
|
<summary>
|
|
Serialises this command to the end of the specified writer.
|
|
</summary>
|
|
<param name="writer">
|
|
The xml writer that the command gets serialised out to.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreatedCommandInstance.SetCommand(RSG.Editor.RockstarRoutedCommand)">
|
|
<summary>
|
|
Sets the command for this user created command instance to the specified value.
|
|
</summary>
|
|
<param name="command">
|
|
The command to set this instance to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.UserCreatedCommandInstance.DeserialiseCommand(System.Xml.XmlReader,System.IFormatProvider)">
|
|
<summary>
|
|
Deserialises the command using the data contained within the specified xml reader.
|
|
</summary>
|
|
<param name="reader">
|
|
The xml reader that contains the command data.
|
|
</param>
|
|
<param name="provider">
|
|
An object that supplies culture-specific formatting information.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.ValueChangedEventArgs`1">
|
|
<summary>
|
|
Provides data for a event that is representing a single change to a specific value.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the value to have changed.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.ValueChangedEventArgs`1._oldValue">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ValueChangedEventArgs`1.OldValue"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.ValueChangedEventArgs`1._newValue">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.ValueChangedEventArgs`1.NewValue"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.ValueChangedEventArgs`1.#ctor(`0,`0)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.ValueChangedEventArgs`1"/>
|
|
class.
|
|
</summary>
|
|
<param name="oldValue">
|
|
The value before the changed occurred.
|
|
</param>
|
|
<param name="newValue">
|
|
The value after the changed occurred.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.ValueChangedEventArgs`1.OldValue">
|
|
<summary>
|
|
Gets the value before the changed occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.ValueChangedEventArgs`1.NewValue">
|
|
<summary>
|
|
Gets the value after the changed occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.CollectionConverterExtensions">
|
|
<summary>
|
|
A static class containing extension methods for the
|
|
<see cref="T:RSG.Editor.View.CollectionConverter`2"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverterExtensions.Convert``2(System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1})">
|
|
<summary>
|
|
Helper extension method for creating a collection converter for a particular
|
|
collection.
|
|
</summary>
|
|
<typeparam name="TSource">
|
|
The type of elements in the source collection.
|
|
</typeparam>
|
|
<typeparam name="TTarget">
|
|
The type of elements in the collection.
|
|
</typeparam>
|
|
<param name="sourceCollection">
|
|
The source collection to convert.
|
|
</param>
|
|
<param name="converter">
|
|
The converter that will be used once per source item before adding them to this
|
|
collection.
|
|
</param>
|
|
<returns>
|
|
A new collection converter class that has converted the items in the source
|
|
enumerable to the target type.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.CollectionConverter`2">
|
|
<summary>
|
|
Represents a collection of objects that have been converted from a source collection of
|
|
objects that also supports collection changes.
|
|
</summary>
|
|
<typeparam name="TSource">
|
|
The type of elements in the source collection.
|
|
</typeparam>
|
|
<typeparam name="TTarget">
|
|
The type of elements in the collection.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.CollectionConverter`2._converter">
|
|
<summary>
|
|
A private reference to the function to use as a converter between the source
|
|
collection and this collection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.CollectionConverter`2._sourceCollection">
|
|
<summary>
|
|
The private reference to the source collection of items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.#ctor(System.Collections.IEnumerable,System.Func{`0,`1})">
|
|
<summary>
|
|
Initialises a new instance of the
|
|
<see cref="T:RSG.Editor.View.CollectionConverter`2"/> class.
|
|
</summary>
|
|
<param name="source">
|
|
The iterator around the source items for this collection.
|
|
</param>
|
|
<param name="converter">
|
|
The converter that will be used once per source item before adding them to this
|
|
collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the
|
|
<see cref="T:RSG.Editor.View.CollectionConverter`2"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.#ctor(System.Collections.IEnumerable)">
|
|
<summary>
|
|
Initialises a new instance of the
|
|
<see cref="T:RSG.Editor.View.CollectionConverter`2"/> class.
|
|
</summary>
|
|
<param name="source">
|
|
The iterator around the source items for this collection.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.CollectionConverter`2.InnerItems">
|
|
<summary>
|
|
Gets this collections items wrapped up in a Suspended Observable Collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.AddCollectionChangedHandler(System.Collections.Specialized.NotifyCollectionChangedEventHandler)">
|
|
<summary>
|
|
Adds the specified handler to this collections collection changed event. This saves
|
|
you from having to cast the collection in your code.
|
|
</summary>
|
|
<param name="handler">
|
|
The handler to add to the collection changed event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.ReceiveWeakEvent(System.Type,System.Object,System.EventArgs)">
|
|
<summary>
|
|
Receives events from the centralized event manager.
|
|
</summary>
|
|
<param name="managerType">
|
|
The type of the System.Windows.WeakEventManager calling this method.
|
|
</param>
|
|
<param name="sender">
|
|
Object that originated the event.
|
|
</param>
|
|
<param name="e">
|
|
Event data.
|
|
</param>
|
|
<returns>
|
|
True if the listener handled the event; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.RemoveCollectionChangedHandler(System.Collections.Specialized.NotifyCollectionChangedEventHandler)">
|
|
<summary>
|
|
Removes the specified handler to this collections collection changed event. This
|
|
saves you from having to cast the collection in your code.
|
|
</summary>
|
|
<param name="handler">
|
|
The handler to remove from the collection changed event.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.ConvertItem(`0)">
|
|
<summary>
|
|
Converts the single specified source item to the target type.
|
|
</summary>
|
|
<param name="item">
|
|
The item to convert.
|
|
</param>
|
|
<returns>
|
|
A new item of the target type converted from the specified source item.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.HandleCollectionChange">
|
|
<summary>
|
|
Gets called whenever the collection changes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.Initialise">
|
|
<summary>
|
|
Initialises this class to handle the associated source collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.InsertSourceItem(System.Int32,`0)">
|
|
<summary>
|
|
Inserts the converted item from the specified source item into this collection at
|
|
the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index where the new item should be inserted.
|
|
</param>
|
|
<param name="item">
|
|
The item whose converted value will added to this collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.MoveSourceItem(System.Int32,System.Int32)">
|
|
<summary>
|
|
Moves the item at the specified old index to the new index in the collection.
|
|
</summary>
|
|
<param name="oldIndex">
|
|
The zero-based index specifying the location of the item to move.
|
|
</param>
|
|
<param name="newIndex">
|
|
The zero-based index specifying the new location of the item.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.RemoveSourceItem(System.Int32)">
|
|
<summary>
|
|
Removes the item at the specified zero-based index from this collection.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the item to remove.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.ReplaceSourceItem(System.Int32,`0)">
|
|
<summary>
|
|
Replaces the item at the specified zero-based index with the specified item.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the item to replace.
|
|
</param>
|
|
<param name="item">
|
|
The item that will replace the item at the specified index.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.ResetSourceItems(System.Collections.IEnumerable)">
|
|
<summary>
|
|
Resets the items in this collection to the items specified.
|
|
</summary>
|
|
<param name="newItems">
|
|
The items that will replace the items currently in this collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.RemoveListener">
|
|
<summary>
|
|
Uses the CollectionChangedEventManager to stop listening to the associated source
|
|
collection for any changes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.CollectionConverter`2.SetupListener">
|
|
<summary>
|
|
Sets up the CollectionChangedEventManager to start listening to the associated
|
|
source collection for any changes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.FilterDescendantBehaviour">
|
|
<summary>
|
|
Defines the different behaviours a item can have when filtering descendants of a item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.FilterDescendantBehaviour.ExcludeDescendantsByDefault">
|
|
<summary>
|
|
This excludes the descendants by default in the filter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.FilterDescendantBehaviour.IncludeDescendantsByDefault">
|
|
<summary>
|
|
This includes the descendants by default in the filter.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.HierarchicalViewModelBase`1">
|
|
<summary>
|
|
Provides a abstract base class that can be inherited by classes that wish to implement
|
|
the <see cref="T:RSG.Editor.View.IViewModel`1"/> interface.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the model that is being wrapped by this view model.
|
|
</typeparam>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.HierarchicalViewModelBase`1.#ctor(`0)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.HierarchicalViewModelBase`1"/> class.
|
|
</summary>
|
|
<param name="model">
|
|
The model that this view model will be wrapping.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IDisplayItem">
|
|
<summary>
|
|
When implemented represents a view model that acts as a single item that the view can
|
|
render.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IDisplayItem.FontStyle">
|
|
<summary>
|
|
Gets the style that the font on this item should be using.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IDisplayItem.FontWeight">
|
|
<summary>
|
|
Gets the weight or thickness that the font on this item should be using.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IDisplayItem.Icon">
|
|
<summary>
|
|
Gets the bitmap source that is used to display the icon for this item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IDisplayItem.Text">
|
|
<summary>
|
|
Gets the text used to display this item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IDisplayItem.ToolTip">
|
|
<summary>
|
|
Gets the text that is used in the tooltip for this item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IDisplayItemWithState">
|
|
<summary>
|
|
When implemented represents a view model that acts as a single item that the view can
|
|
render that includes properties that can be also to render the state of the item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IDisplayItemWithState.OverlayIcon">
|
|
<summary>
|
|
Gets the bitmap source that is used to display the overlay icon for this item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IDisplayItemWithState.StateIcon">
|
|
<summary>
|
|
Gets the bitmap source that is used to display the state icon for this item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IDisplayItemWithState.StateToolTipText">
|
|
<summary>
|
|
Gets the text that is used to represent the state of this item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IFilteredItemsSource">
|
|
<summary>
|
|
Represents the items source for a filtered collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.IFilteredItemsSource.GetFilterDescendantsBehavior(System.Object)">
|
|
<summary>
|
|
Retrieves a value indicating the behaviour of the filter for the specified item.
|
|
</summary>
|
|
<param name="item">
|
|
The item to get the filter behaviour for.
|
|
</param>
|
|
<returns>
|
|
The filter behaviour for the specified item.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IHieraricalDisplayItem">
|
|
<summary>
|
|
When implemented represents a a view model that acts as a single display item that the
|
|
view can render that also contains properties that are specific to a item instance a
|
|
hierarchy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IHieraricalDisplayItem.ExpandedIcon">
|
|
<summary>
|
|
Gets the bitmap source that is used to display the icon for this item when this
|
|
item is in a expanded state.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IHieraricalDisplayItem.IsExpandable">
|
|
<summary>
|
|
Gets a value indicating whether this display item can be expanded.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IInvokable">
|
|
<summary>
|
|
When implemented represents a object publishes a <see cref="T:RSG.Editor.View.IInvokeController"/> that
|
|
can be used to perform a action on the item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IInvokable.InvokeController">
|
|
<summary>
|
|
Gets the invoke controller that can be used to perform a action on this object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IInvokeController">
|
|
<summary>
|
|
When implemented represents a class that can be used to invoke a specific action on
|
|
a collection of objects from a input source.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.IInvokeController.Invoke(System.Collections.Generic.IEnumerable{System.Object},RSG.Editor.View.InputSource,System.Windows.IInputElement)">
|
|
<summary>
|
|
Invokes a action on each item in the specified list.
|
|
</summary>
|
|
<param name="items">
|
|
A list of items that should be invoked.
|
|
</param>
|
|
<param name="inputSource">
|
|
The source of the input that has caused this invoke.
|
|
</param>
|
|
<param name="element">
|
|
The input element that was the source for this invoke.
|
|
</param>
|
|
<returns>
|
|
True if any of the specified items have been invoked successfully.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.InputSource">
|
|
<summary>
|
|
Defines the different places/devices that can supply input.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.InputSource.None">
|
|
<summary>
|
|
There is no specific input source defined.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.InputSource.Mouse">
|
|
<summary>
|
|
The input source has come directly from a mouse device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.InputSource.Keyboard">
|
|
<summary>
|
|
The input source has come directly from a keyboard device.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IProvidesExpandableState">
|
|
<summary>
|
|
When implemented represents a item that contains a default expansion state that can be
|
|
used by the user interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IProvidesExpandableState.IsExpandable">
|
|
<summary>
|
|
Gets or sets a value indicating whether this item is expanded by default in the user
|
|
interface when by rendered inside a hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IRenameable">
|
|
<summary>
|
|
When implemented represents a object publishes a <see cref="T:RSG.Editor.View.IRenameController"/> that
|
|
can be used to rename the item from the user interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IRenameable.CanBeRenamed">
|
|
<summary>
|
|
Gets a value indicating whether this item can be currently renamed by the
|
|
controller.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.IRenameable.BeginRename(System.Object)">
|
|
<summary>
|
|
Gets the rename controller that is used to rename this item with the specified
|
|
container.
|
|
</summary>
|
|
<param name="containerDataContext">
|
|
The data context of the container in the user interface that this item is being
|
|
shown inside.
|
|
</param>
|
|
<returns>
|
|
The rename controller to use for this item.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IRenameController">
|
|
<summary>
|
|
When implemented represents a class that can be used to rename a single item.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.View.IRenameController.Completed">
|
|
<summary>
|
|
Occurrs when the renaming operation has finished. This doesn't indicate success
|
|
just that the operation has finished.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IRenameController.ContainerDataContext">
|
|
<summary>
|
|
Gets the data context for the item that is being renamed. This is the object that
|
|
comes from the view and is used to both scroll to the item and find the correct
|
|
view object to put into its edit mode.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IRenameController.IsIncomplete">
|
|
<summary>
|
|
Gets a value indicating whether the controller is in a incomplete state. (i.e
|
|
the cancel or commit methods hasn't been called).
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IRenameController.Item">
|
|
<summary>
|
|
Gets the item this controller is renaming.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IRenameController.Text">
|
|
<summary>
|
|
Gets or sets the text that is currently being edited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.IRenameController.Cancel(System.Boolean)">
|
|
<summary>
|
|
Cancels the renaming operation.
|
|
</summary>
|
|
<param name="refocus">
|
|
A value indicating whether the item being renamed should be refocused. This is true
|
|
if the renaming was cancelled for any reason other than the user clicking
|
|
elsewhere.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.IRenameController.Commit(System.Boolean)">
|
|
<summary>
|
|
Commits the renaming operation to validation.
|
|
</summary>
|
|
<param name="refocus">
|
|
A value indicating whether the item being renamed should be refocused. This is true
|
|
if the renaming was commit for any reason other than the user clicking elsewhere.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ISupportsDisposalState">
|
|
<summary>
|
|
When implemented represents a object that contains a property that specifies whether it
|
|
has been disposed of and a event that fires when it changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ISupportsDisposalState.IsDisposed">
|
|
<summary>
|
|
Gets a value indicating whether this instance has been disposed of.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ISupportsExpansionEvents">
|
|
<summary>
|
|
When implemented represents a object that has methods related to the item getting
|
|
expanded and collapsed in the user interface so that it can respond accordingly.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ISupportsExpansionEvents.BeforeExpand">
|
|
<summary>
|
|
Called just before this object in the user interface is expanded inside a
|
|
hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ISupportsExpansionEvents.AfterCollapse">
|
|
<summary>
|
|
Called just after this object in the user interface is collapsed inside a
|
|
hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ISupportsExpansionState">
|
|
<summary>
|
|
When implemented represents a item that contains a default expansion state that can be
|
|
used by the user interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ISupportsExpansionState.IsExpandedByDefault">
|
|
<summary>
|
|
Gets a value indicating whether this item is expanded by default in the user
|
|
interface when by rendered inside a hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ISupportsExpansionState.DestroyNodesOnCollapse">
|
|
<summary>
|
|
Gets a value indicating whether this items children are destroyed when it is
|
|
collapsed. The resulting behaviour if true is that the references are kept in a
|
|
cache and the expansion state is persistent for child nodes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IPrioritisedComparable">
|
|
<summary>
|
|
When implemented represents a object that contains a property that specifies a
|
|
priority value for the object and a method that can be used to sort its instances.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IPrioritisedComparable.Priority">
|
|
<summary>
|
|
Gets the priority value for this object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ISupportsRefresh">
|
|
<summary>
|
|
When implemented represents a item that can be asynchronously refreshed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ISupportsRefresh.RefreshAsync">
|
|
<summary>
|
|
Refreshes this item asynchronously.
|
|
</summary>
|
|
<returns>
|
|
A task that represents the work done to refresh this item.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ISupportsRefresh.CancelLoad">
|
|
<summary>
|
|
Cancels the asynchronous refresh operation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ISupportsSelectionEvents">
|
|
<summary>
|
|
When implemented represents a object that has methods related to the item getting
|
|
selected and unselected in the user interface so that it can respond accordingly.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ISupportsSelectionEvents.BeforeSelected">
|
|
<summary>
|
|
Called just before this object in the user interface is selected.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ISupportsSelectionEvents.AfterUnselected">
|
|
<summary>
|
|
Called just after this object in the user interface is unselected.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ISupportsSelectionState">
|
|
<summary>
|
|
When implemented represents a item that contains a default expansion state that can be
|
|
used by the user interface.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ISupportsSelectionState.IsSelectedByDefault">
|
|
<summary>
|
|
Gets a value indicating whether this item is selected by default in the user
|
|
interface.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ISupportsStateInformation">
|
|
<summary>
|
|
When implemented represents a item that contains state information about the object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ISupportsStateInformation.Overlayicon">
|
|
<summary>
|
|
Gets the icon that is used to display the state of this item over the normal icon.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ISupportsStateInformation.StateIcon">
|
|
<summary>
|
|
Gets the icon that is used to display the state of this item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ISupportsStateInformation.StateToolTipText">
|
|
<summary>
|
|
Gets the tooltip text that this item has that describes its current state.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ITreeDisplayItem">
|
|
<summary>
|
|
When implemented represents a view model that acts as a single item that the view can
|
|
render as a tree view item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ITreeDisplayItem.ExpandedIcon">
|
|
<summary>
|
|
Gets the bitmap source that is used to display the icon for this item when it has
|
|
been expanded.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IValidating">
|
|
<summary>
|
|
When implemented represents a object that can be validated and have validation
|
|
dependencies.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IValidating.CurrentValidation">
|
|
<summary>
|
|
Gets the current validation result container obtained from the previous validation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.IValidating.Validate">
|
|
<summary>
|
|
Validates this object using the INotifyDataErrorInfo interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.IValidating.ValidateAsync">
|
|
<summary>
|
|
Validates this object asynchronously using the INotifyDataErrorInfo interface.
|
|
</summary>
|
|
<returns>
|
|
A task that represents the work done by the validation logic.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IViewModel">
|
|
<summary>
|
|
Represents a generic view model that can be used in binding to the view.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IViewModel.Model">
|
|
<summary>
|
|
Gets the model that this view model is currently wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IViewModel`1">
|
|
<summary>
|
|
Represents a view model object that is representing a model of the specified type.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the model that is being wrapped by this view model.
|
|
</typeparam>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.IViewModel`1.Model">
|
|
<summary>
|
|
Gets the model that this view model is currently wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.RenameControllerCompletedEventArgs">
|
|
<summary>
|
|
Contains the event data for the rename controllers completed event.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.RenameControllerCompletedEventArgs._refocus">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.RenameControllerCompletedEventArgs.Refocus"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.RenameControllerCompletedEventArgs._result">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.RenameControllerCompletedEventArgs.Result"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.RenameControllerCompletedEventArgs.#ctor(System.Boolean,RSG.Editor.View.RenameControllerCompletedResult)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.RenameControllerCompletedEventArgs"/>
|
|
class.
|
|
</summary>
|
|
<param name="refocus">
|
|
A value indicating whether the view item should regain focus after the operation.
|
|
</param>
|
|
<param name="result">
|
|
The result of the renaming operation.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.RenameControllerCompletedEventArgs.Refocus">
|
|
<summary>
|
|
Gets a value indicating whether the view item should regain focus.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.RenameControllerCompletedEventArgs.Result">
|
|
<summary>
|
|
Gets the result of the rename controller.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.RenameControllerCompletedResult">
|
|
<summary>
|
|
Defines the different completion results for a rename controller.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.RenameControllerCompletedResult.Successful">
|
|
<summary>
|
|
The controller completed due to the fact the item was renamed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.RenameControllerCompletedResult.ValidationFailed">
|
|
<summary>
|
|
The controller completed due to the fact the validation failed causing no renaming
|
|
to occur.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.RenameControllerCompletedResult.Cancelled">
|
|
<summary>
|
|
The controller completed due to the user cancelling the operation causing no
|
|
renaming to occur.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.SortedObservableCollection`1">
|
|
<summary>
|
|
Represents a observable collection which sorts it's contents based on the default
|
|
comparer for type T.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of elements in the collection.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.SortedObservableCollection`1._comparer">
|
|
<summary>
|
|
The comparer to use when inserting items.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.SortedObservableCollection`1._internalList">
|
|
<summary>
|
|
The internal sorted list of items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.#ctor(System.Collections.Generic.IComparer{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> class
|
|
with a optional comparer.
|
|
</summary>
|
|
<param name="comparer">
|
|
Optional comparer to use for sorting the collection.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> class
|
|
based on a pre-existing list of items and optional taking a custom comparer.
|
|
</summary>
|
|
<param name="items">
|
|
The items to add to the sorted list.
|
|
</param>
|
|
<param name="comparer">
|
|
Optional comparer to use for sorting the collection.
|
|
</param>
|
|
</member>
|
|
<member name="E:RSG.Editor.View.SortedObservableCollection`1.CollectionChanged">
|
|
<summary>
|
|
Triggered whenever the internal list of items changes.
|
|
</summary>
|
|
</member>
|
|
<member name="E:RSG.Editor.View.SortedObservableCollection`1.PropertyChanged">
|
|
<summary>
|
|
Triggered when the <see cref="P:RSG.Editor.View.SortedObservableCollection`1.Count"/> property changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.SortedObservableCollection`1.Count">
|
|
<summary>
|
|
Gets the number of elements contained in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.SortedObservableCollection`1.IsReadOnly">
|
|
<summary>
|
|
Gets a value indicating whether the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> is
|
|
read-only.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.SortedObservableCollection`1.Item(System.Int32)">
|
|
<summary>
|
|
Gets or sets the element at the specified index.
|
|
</summary>
|
|
<remarks>
|
|
This is not supported by the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> class.
|
|
</remarks>
|
|
<param name="index">
|
|
The zero-based index of the element to get or set.
|
|
</param>
|
|
<returns>
|
|
The element at the specified index.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Index is not a valid index in the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
Trying to set a item via the setter.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.Add(`0)">
|
|
<summary>
|
|
Adds an item to the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</summary>
|
|
<param name="item">
|
|
The object to add to the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.Clear">
|
|
<summary>
|
|
Removes all items from the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.Contains(`0)">
|
|
<summary>
|
|
Determines whether the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> contains a
|
|
specific value.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</param>
|
|
<returns>
|
|
True if item is found in the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>;
|
|
otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.CopyTo(`0[],System.Int32)">
|
|
<summary>
|
|
Copies the elements of the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> to an
|
|
System.Array, starting at a particular System.Array index.
|
|
</summary>
|
|
<param name="array">
|
|
The one-dimensional System.Array that is the destination of the elements
|
|
copied from <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>. The System.Array must
|
|
have zero-based indexing.
|
|
</param>
|
|
<param name="arrayIndex">
|
|
The zero-based index in array at which copying begins.
|
|
</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="arrayIndex"/> is less than 0.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The number of elements in the source <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>
|
|
is greater than the available space from arrayIndex to the end of the destination
|
|
array.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through
|
|
the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through a collection.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:System.Collections.Generic.IEnumerator`1"/> object that can be used to iterate through
|
|
the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.IndexOf(`0)">
|
|
<summary>
|
|
Determines the index of a specific item in the
|
|
<see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</param>
|
|
<returns>
|
|
The index of item if found in the list; otherwise, -1.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.Insert(System.Int32,`0)">
|
|
<summary>
|
|
Inserts an item to the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> at the specified
|
|
index.
|
|
</summary>
|
|
<remarks>
|
|
This is not supported by the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> class.
|
|
</remarks>
|
|
<param name="index">
|
|
The zero-based index at which item should be inserted.
|
|
</param>
|
|
<param name="item">
|
|
The object to insert into the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</param>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
This method isn't supported by the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>
|
|
class.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.Remove(`0)">
|
|
<summary>
|
|
Removes the first occurrence of a specific object from the
|
|
<see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</summary>
|
|
<param name="item">
|
|
The object to remove from the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</param>
|
|
<returns>
|
|
True if item was successfully removed from the
|
|
<see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>; otherwise, false. This method also
|
|
returns false if item is not found in the original
|
|
<see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.RemoveAt(System.Int32)">
|
|
<summary>
|
|
Removes the item at the specified index.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index of the item to remove.
|
|
</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index"/> is not a valid index in the
|
|
<see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.OnCollectionReset">
|
|
<summary>
|
|
Called to notify listeners that the <see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> has
|
|
been reset.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.OnItemAdded(`0,System.Int32)">
|
|
<summary>
|
|
Called to notify listeners that a new item has been added to the
|
|
<see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</summary>
|
|
<param name="item">
|
|
The item that was added.
|
|
</param>
|
|
<param name="index">
|
|
The index at which it was added to.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.OnItemRemoved(`0,System.Int32)">
|
|
<summary>
|
|
Called to notify listeners that an item has been removed from the
|
|
<see cref="T:RSG.Editor.View.SortedObservableCollection`1"/>.
|
|
</summary>
|
|
<param name="item">
|
|
The item that was removed.
|
|
</param>
|
|
<param name="index">
|
|
The index where the item was removed from.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SortedObservableCollection`1.OnPropertyChanged(System.String)">
|
|
<summary>
|
|
Called to notify listeners that a property of the
|
|
<see cref="T:RSG.Editor.View.SortedObservableCollection`1"/> has changed.
|
|
</summary>
|
|
<param name="name">
|
|
Name of the property that has changed.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.StableEnumerable">
|
|
<summary>
|
|
Represents a IEnumerable that can handle changes being made to it while moving
|
|
through the items.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.StableEnumerable._stableList">
|
|
<summary>
|
|
The private list containing the stable items that are iterated through.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.StableEnumerable._detectedChange">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.StableEnumerable.DetectedChange"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.StableEnumerable._source">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.StableEnumerable.Source"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.StableEnumerable.#ctor(System.Collections.IEnumerable)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.StableEnumerable"/> class.
|
|
</summary>
|
|
<param name="source">
|
|
The source collection to iterate through.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.StableEnumerable.DetectedChange">
|
|
<summary>
|
|
Gets a value indicating whether the collection has changed during iteration.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.StableEnumerable.Source">
|
|
<summary>
|
|
Gets or sets the private reference to the source collection cast to a
|
|
INotifyCollectionChanged object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.StableEnumerable.GetEnumerator">
|
|
<summary>
|
|
Retrieves an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>
|
|
An enumerator that iterates through the collection.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.StableEnumerable.DisposeManagedResources">
|
|
<summary>
|
|
Disposes of the managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.StableEnumerable.OnCollectionChanged(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Called whenever the collection changes.
|
|
</summary>
|
|
<param name="sender">
|
|
The collection that has changed.
|
|
</param>
|
|
<param name="e">
|
|
The System.EventArgs data for the event.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.SuspendableObservableCollection`1">
|
|
<summary>
|
|
Represents a observable collection of the specified type that can have its change
|
|
events suspended for a set period of time.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of elements in the collection.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.SuspendableObservableCollection`1._changesCount">
|
|
<summary>
|
|
The number of changes that have occurred and have been supressed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.SuspendableObservableCollection`1._skippedNotification">
|
|
<summary>
|
|
A value indicating whether a notification has been skipped while the collection
|
|
events have been suspended.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.SuspendableObservableCollection`1.AreNotificationsSuspended">
|
|
<summary>
|
|
Gets a value indicating whether any notifications are currently suspended.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SuspendableObservableCollection`1.SuspendChangeNotification">
|
|
<summary>
|
|
Retrieves a new instance of the change scope that can be used to manage the
|
|
suppression of the collection changes.
|
|
</summary>
|
|
<returns>
|
|
A new instance of the change scope that can be used to manage the suppression of
|
|
the collection changes.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SuspendableObservableCollection`1.OnCollectionChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
|
|
<summary>
|
|
Raises the CollectionChanged event with the provided arguments.
|
|
</summary>
|
|
<param name="e">
|
|
Arguments of the event being raised.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SuspendableObservableCollection`1.OnPropertyChanged(System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Raises the PropertyChanged event with the provided arguments.
|
|
</summary>
|
|
<param name="e">
|
|
Arguments of the event being raised.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.SuspendableObservableCollection`1.ChangesScope">
|
|
<summary>
|
|
A class that manages the scope of suppression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.SuspendableObservableCollection`1.ChangesScope._collection">
|
|
<summary>
|
|
The private reference to the collection being suspended.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SuspendableObservableCollection`1.ChangesScope.#ctor(RSG.Editor.View.SuspendableObservableCollection{`0})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.SuspendableObservableCollection`1.ChangesScope"/> class.
|
|
</summary>
|
|
<param name="collection">
|
|
The collection whose events have been suspended.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.SuspendableObservableCollection`1.ChangesScope.DisposeManagedResources">
|
|
<summary>
|
|
When overridden disposes of the managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ThreadedHierarchicalBase">
|
|
<summary>
|
|
Provides a abstract base class that can be inherited by classes that wish to have a
|
|
child collection that can be constructed asynchronously.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedHierarchicalBase._isExpandable">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ThreadedHierarchicalBase.IsExpandable"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedHierarchicalBase._items">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ThreadedHierarchicalBase.Items"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedHierarchicalBase.#ctor">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.ThreadedHierarchicalBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalBase.DestroyNodesOnCollapse">
|
|
<summary>
|
|
Gets a value indicating whether this items children are destroyed when it is
|
|
collapsed. The resulting behaviour if true is that the references are kept in a
|
|
cache and the expansion state is persistent for child nodes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalBase.IsExpandable">
|
|
<summary>
|
|
Gets or sets a value indicating whether this item can be expanded.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalBase.IsExpandedByDefault">
|
|
<summary>
|
|
Gets a value indicating whether this item is expanded by default in the user
|
|
interface when by rendered inside a hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalBase.Items">
|
|
<summary>
|
|
Gets the items that have been added underneath this view model as children.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalBase.BatchAddChildren">
|
|
<summary>
|
|
Gets a value indicating whether the children get added to the items collection in
|
|
one go after initialisation or one at a time during initialisation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalBase.CreateChildrenDuringConstruction">
|
|
<summary>
|
|
Gets a value indicating whether the child items for this view model get created
|
|
straight away during construction.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedHierarchicalBase.AfterCollapse">
|
|
<summary>
|
|
Called just after this object in the user interface is collapsed inside a
|
|
hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedHierarchicalBase.BeforeExpand">
|
|
<summary>
|
|
Called just before this object in the user interface is expanded inside a
|
|
hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedHierarchicalBase.CreateChildren(System.Collections.Generic.ICollection{System.Object})">
|
|
<summary>
|
|
Override to create the child elements for this view model. This is only called once
|
|
the item has been expanded in the user interface.
|
|
</summary>
|
|
<param name="collection">
|
|
The collection to add the elements to.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2">
|
|
<summary>
|
|
Provides a abstract base class that can be inherited by classes that wish to implement
|
|
the <see cref="T:RSG.Editor.View.IViewModel`1"/> interface.
|
|
</summary>
|
|
<typeparam name="TModel">
|
|
The type of the model that is being wrapped by this view model.
|
|
</typeparam>
|
|
<typeparam name="TChild">
|
|
The type of the child items for this view model.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2._isExpandable">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.IsExpandable"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2._items">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.Items"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.#ctor(`0)">
|
|
<summary>
|
|
Initialises a new instance of the
|
|
<see cref="T:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2"/> class.
|
|
</summary>
|
|
<param name="model">
|
|
The model that this view model will be wrapping.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.DestroyNodesOnCollapse">
|
|
<summary>
|
|
Gets a value indicating whether this items children are destroyed when it is
|
|
collapsed. The resulting behaviour if true is that the references are kept in a
|
|
cache and the expansion state is persistent for child nodes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.IsExpandable">
|
|
<summary>
|
|
Gets or sets a value indicating whether this item can be expanded.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.IsExpandedByDefault">
|
|
<summary>
|
|
Gets a value indicating whether this item is expanded by default in the user
|
|
interface when by rendered inside a hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.Items">
|
|
<summary>
|
|
Gets the items that have been added underneath this view model as children.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.BatchAddChildren">
|
|
<summary>
|
|
Gets a value indicating whether the children get added to the items collection in
|
|
one go after initialisation or one at a time during initialisation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.CreateChildrenDuringConstruction">
|
|
<summary>
|
|
Gets a value indicating whether the child items for this view model get created
|
|
straight away during construction.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.AfterCollapse">
|
|
<summary>
|
|
Called just after this object in the user interface is collapsed inside a
|
|
hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.BeforeExpand">
|
|
<summary>
|
|
Called just before this object in the user interface is expanded inside a
|
|
hierarchical control.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedHierarchicalViewModelBase`2.CreateChildren(System.Collections.Generic.ICollection{`1})">
|
|
<summary>
|
|
Override to create the child elements for this view model. This is only called once
|
|
the item has been expanded in the user interface.
|
|
</summary>
|
|
<param name="collection">
|
|
The collection to add the elements to.
|
|
</param>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ThreadedViewModelCollection`1">
|
|
<summary>
|
|
Represents a collection of objects that can be access via a index or iterated over.
|
|
This collection supports thread initialisation.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of elements in the collection.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedViewModelCollection`1._initialisationDelegate">
|
|
<summary>
|
|
The private initialisation delegate that is called on calling the
|
|
<see cref="M:RSG.Editor.View.ThreadedViewModelCollection`1.BeginInit"/> method.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedViewModelCollection`1._isInitialised">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ThreadedViewModelCollection`1.IsInitialized"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedViewModelCollection`1._isInitialising">
|
|
<summary>
|
|
A private value indicating whether this collection is current being initialised.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedViewModelCollection`1._batchAddChildren">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ThreadedViewModelCollection`1.BatchAddChildren"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ThreadedViewModelCollection`1._lock">
|
|
<summary>
|
|
The generic object that provides a synchronisation lock for this collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedViewModelCollection`1.#ctor(System.Action{System.Collections.Generic.ICollection{`0}})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.ThreadedViewModelCollection`1"/>
|
|
class.
|
|
</summary>
|
|
<param name="initialisationDelegate">
|
|
The private action that is called when initialisation takes place.
|
|
</param>
|
|
</member>
|
|
<member name="E:RSG.Editor.View.ThreadedViewModelCollection`1.Initialized">
|
|
<summary>
|
|
Occurs when initialisation of the component is completed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedViewModelCollection`1.IsInitialized">
|
|
<summary>
|
|
Gets a value indicating whether the component is initialised.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ThreadedViewModelCollection`1.BatchAddChildren">
|
|
<summary>
|
|
Gets or sets a value indicating whether the children get added to the items
|
|
collection in one go after initialisation or one at a time during initialisation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedViewModelCollection`1.ClearInitialisationFlag">
|
|
<summary>
|
|
Clears all of the elements in this collection and resets the is initialised flag to
|
|
false.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedViewModelCollection`1.BeginInit">
|
|
<summary>
|
|
Signals the collection that initialisation is starting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedViewModelCollection`1.EndInit">
|
|
<summary>
|
|
Signals the collection that initialisation is complete.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedViewModelCollection`1.SetInitialisationFlag">
|
|
<summary>
|
|
Sets this collections initialisation flag to true.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ThreadedViewModelCollection`1.CallDelegate(System.Collections.Generic.ICollection{`0})">
|
|
<summary>
|
|
Calls the associated delegate for this collection.
|
|
</summary>
|
|
<param name="children">
|
|
The child collection that should be passed to the initialisation delegate.
|
|
</param>
|
|
<returns>
|
|
A task that represents the work to do to call the initialisation delegate.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ValidatingViewModelBase`1">
|
|
<summary>
|
|
Provides a abstract base class that can be inherited by classes that wish to implement
|
|
the <see cref="T:RSG.Editor.View.IViewModel`1"/> interface and support data validation.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the model that is being wrapped by this view model.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ValidatingViewModelBase`1._errorLock">
|
|
<summary>
|
|
A generic object used to lock the errors dictionary for thread safety.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ValidatingViewModelBase`1._currentValidation">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ValidatingViewModelBase`1.CurrentValidation"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ValidatingViewModelBase`1._suspendedStateCount">
|
|
<summary>
|
|
The private count showing the number of times the validation for this object has
|
|
been suspended.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ValidatingViewModelBase`1._validateOnPropertyChange">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ValidatingViewModelBase`1.ValidateOnPropertyChange"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.#ctor(`0,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.ValidatingViewModelBase`1"/> class.
|
|
</summary>
|
|
<param name="model">
|
|
The model that this view model will be wrapping.
|
|
</param>
|
|
<param name="forwardPropertyChanges">
|
|
A value indicating whether the property changed events from the specified model are
|
|
forwarded on through this object.
|
|
</param>
|
|
<param name="validateOnPropertyChange">
|
|
A value indicating whether validation takes place asynchronously whenever a
|
|
property's value changes.
|
|
</param>
|
|
</member>
|
|
<member name="E:RSG.Editor.View.ValidatingViewModelBase`1.ErrorsChanged">
|
|
<summary>
|
|
Occurs when the validation errors have changed for a property or for the entire
|
|
entity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ValidatingViewModelBase`1.CurrentValidation">
|
|
<summary>
|
|
Gets the current validation result container obtained from the previous validation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ValidatingViewModelBase`1.ErrorLock">
|
|
<summary>
|
|
Gets the lock object that is used to access the current validation object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ValidatingViewModelBase`1.HasErrors">
|
|
<summary>
|
|
Gets a value indicating whether the entity has validation errors.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ValidatingViewModelBase`1.ValidateOnPropertyChange">
|
|
<summary>
|
|
Gets or sets a value indicating whether the validation should takes place
|
|
asynchronously whenever a property's value changes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.GetErrors(System.String)">
|
|
<summary>
|
|
Gets the validation errors for a specified property or for the entire entity.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property to retrieve validation errors for; or null or Empty, to
|
|
retrieve entity-level errors.
|
|
</param>
|
|
<returns>
|
|
The validation errors for the property or entity.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.OnErrorsChanged(System.String)">
|
|
<summary>
|
|
Fires the errors changed event that the user interface is listening to through the
|
|
binding engine.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property whose errors have changed.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.SuspendValidation">
|
|
<summary>
|
|
Retrieves a disposable object that is used to create a region of code where the
|
|
validation due to property changes has been suspended.
|
|
</summary>
|
|
<returns>
|
|
A disposable object that started the suspension of the validation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.Validate">
|
|
<summary>
|
|
Validates this object using the INotifyDataErrorInfo interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.ValidateAsync">
|
|
<summary>
|
|
Validates this object asynchronously using the INotifyDataErrorInfo interface.
|
|
</summary>
|
|
<returns>
|
|
A task that represents the work done by the validation logic.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.OnModelPropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Runs the validation pipeline for this object as long as the property being changed
|
|
in the model has been registered and the validation on property change property
|
|
boolean is set to true.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs containing the event data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.OnValidationRun(System.String)">
|
|
<summary>
|
|
Called whenever the validation has finished running due to a change to the property
|
|
with the specified name.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property that was changed to cause the validation to run.
|
|
</param>
|
|
<remarks>
|
|
This doesn't get called if there wasn't a property name attached to the validation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.ResolveGetErrorsPropertyName(System.String)">
|
|
<summary>
|
|
Override to resolve a property name whose error list has been requested by the
|
|
validation system. Use this in the case where the bounded to property's name is
|
|
different then the model property's name.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The original name of the property.
|
|
</param>
|
|
<returns>
|
|
The resolved property name.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.ShouldRunValidation(System.String)">
|
|
<summary>
|
|
Determines whether the validation pipeline should be started due to the property
|
|
with the specified name changing.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The property name to test.
|
|
</param>
|
|
<returns>
|
|
True if the validation should be run due to the specified property changing;
|
|
otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.ValidateCore(System.String)">
|
|
<summary>
|
|
The core method used to validate this class. By default this calls the models
|
|
validate methods and uses that result.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property if this validation is associated with a change to a
|
|
specific property; otherwise, null.
|
|
</param>
|
|
<returns>
|
|
The result of the validation.
|
|
</returns>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.Validate(System.String)">
|
|
<summary>
|
|
Validates this object using the INotifyDataErrorInfo interface.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property if this validation is associated with a change to a
|
|
specific property; otherwise, null.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.ValidateAsync(System.String)">
|
|
<summary>
|
|
Validates this object asynchronously using the INotifyDataErrorInfo interface.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The name of the property if this validation is associated with a change to a
|
|
specific property; otherwise, null.
|
|
</param>
|
|
<returns>
|
|
A task that represents the work done by the validation logic.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ValidatingViewModelBase`1.SuspendValidationScope`1">
|
|
<summary>
|
|
Provides functionality so that the validation based on property changes can be
|
|
suspended for a specific view model.
|
|
</summary>
|
|
<typeparam name="J">
|
|
The type of the model that the suspended view model is wrapping.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ValidatingViewModelBase`1.SuspendValidationScope`1._viewModel">
|
|
<summary>
|
|
Gets the view model instance that this suspension was created for.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.SuspendValidationScope`1.#ctor(RSG.Editor.View.ValidatingViewModelBase{`1})">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="M:RSG.Editor.View.ValidatingViewModelBase`1.SuspendValidation"/> class.
|
|
</summary>
|
|
<param name="viewModel">
|
|
A instance of the view model whose validation will be suspended.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ValidatingViewModelBase`1.SuspendValidationScope`1.DisposeManagedResources">
|
|
<summary>
|
|
Finishes the suspended state that this object represents on the associated
|
|
view model.
|
|
</summary>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.ViewModelBase`1">
|
|
<summary>
|
|
Provides a abstract base class that can be inherited by classes that wish to implement
|
|
the <see cref="T:RSG.Editor.View.IViewModel`1"/> interface.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of the model that is being wrapped by this view model.
|
|
</typeparam>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ViewModelBase`1._fontStyle">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ViewModelBase`1.FontStyle"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ViewModelBase`1._fontWeight">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ViewModelBase`1.FontWeight"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ViewModelBase`1._forwardPropertyChanges">
|
|
<summary>
|
|
A private value indicating whether the property changed events from the model
|
|
should be forwarded on from the model.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ViewModelBase`1._icon">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ViewModelBase`1.Icon"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ViewModelBase`1._model">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ViewModelBase`1.Model"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ViewModelBase`1._text">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ViewModelBase`1.Text"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:RSG.Editor.View.ViewModelBase`1._tooltip">
|
|
<summary>
|
|
The private field used for the <see cref="P:RSG.Editor.View.ViewModelBase`1.ToolTip"/> property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ViewModelBase`1.#ctor(`0)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.ViewModelBase`1"/> class.
|
|
</summary>
|
|
<param name="model">
|
|
The model that this view model will be wrapping.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ViewModelBase`1.#ctor(`0,System.Boolean)">
|
|
<summary>
|
|
Initialises a new instance of the <see cref="T:RSG.Editor.View.ViewModelBase`1"/> class.
|
|
</summary>
|
|
<param name="model">
|
|
The model that this view model will be wrapping.
|
|
</param>
|
|
<param name="forwardPropertyChanges">
|
|
A value indicating whether the property changed events from the specified model are
|
|
forwarded on through this object.
|
|
</param>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ViewModelBase`1.FontStyle">
|
|
<summary>
|
|
Gets or sets the style that the font on this item should be using.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ViewModelBase`1.FontWeight">
|
|
<summary>
|
|
Gets or sets the weight or thickness that the font on this item should be using.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ViewModelBase`1.Icon">
|
|
<summary>
|
|
Gets or sets the bitmap source that is used to display the icon for this item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ViewModelBase`1.RSG#Editor#View#IViewModel#Model">
|
|
<summary>
|
|
Gets the model that this view model is currently wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ViewModelBase`1.Model">
|
|
<summary>
|
|
Gets the model that this view model is currently wrapping.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ViewModelBase`1.Text">
|
|
<summary>
|
|
Gets or sets the text used to display this item.
|
|
</summary>
|
|
</member>
|
|
<member name="P:RSG.Editor.View.ViewModelBase`1.ToolTip">
|
|
<summary>
|
|
Gets or sets the text that is used in the tooltip for this item.
|
|
</summary>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ViewModelBase`1.OnModelChanged(`0,`0)">
|
|
<summary>
|
|
Called whenever the model is replaced with a new value after first initialisation.
|
|
</summary>
|
|
<param name="oldValue">
|
|
The original value that has been replaced.
|
|
</param>
|
|
<param name="newValue">
|
|
The new value that is now the model for this view model.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ViewModelBase`1.OnModelPropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
|
|
<summary>
|
|
Forwards any property changed event received from the model onto any object whose
|
|
listening to the same event on this object.
|
|
</summary>
|
|
<param name="s">
|
|
The object this handler is attached to.
|
|
</param>
|
|
<param name="e">
|
|
The System.ComponentModel.PropertyChangedEventArgs containing the event data.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ViewModelBase`1.ReplaceModel(`0,System.Boolean)">
|
|
<summary>
|
|
Replaces the current model with the specified model.
|
|
</summary>
|
|
<param name="model">
|
|
The reference that will become the new model.
|
|
</param>
|
|
<param name="forwardPropertyChanges">
|
|
A valid indicating whether the property changes from the new model should be
|
|
forwarded through this object.
|
|
</param>
|
|
</member>
|
|
<member name="M:RSG.Editor.View.ViewModelBase`1.ResolvePropertyNameOnChange(System.String)">
|
|
<summary>
|
|
Override to resolve a property name that's property changed event is being
|
|
forwarded. Use this if you need to have a property change event from the model fire
|
|
for a property in the view model with a different name.
|
|
</summary>
|
|
<param name="propertyName">
|
|
The original name of the property.
|
|
</param>
|
|
<returns>
|
|
The resolved property name.
|
|
</returns>
|
|
</member>
|
|
<member name="T:RSG.Editor.View.IReadOnlyViewModelCollection`1">
|
|
<summary>
|
|
When implemented represents a collection of objects that can be access via a index or
|
|
iterated over and also fire an event whenever the items change.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of elements in the collection.
|
|
</typeparam>
|
|
</member>
|
|
</members>
|
|
</doc>
|