PlayAudioAction class

An enhancement used effectively as a shortcut for previewing audio.

Inheritance

Constructors

PlayAudioAction()
Initialise this enhancement with the hardset parameters.

Properties

description → String
A longer description of what the action can do, or details left by or regarding the developer.
finalinherited
descriptionLocalisation → Map<String, String>
Localisations for this action, where the key is a locale tag and the value is the description of the action. If the value for the current locale is non-null, it will be used instead of description.
finalinherited
hashCode → int
The hash code for this object.
read-onlyinherited
icon → IconData
An icon that will show the action if activated by the user in the quick menu.
finalinherited
label → String
Name of the action that very shortly describes what it does.
finalinherited
labelLocalisation → Map<String, String>
Localisations for this action, where the key is a locale tag and the value is the label of the action. If the value for the current locale is non-null, it will be used instead of label.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
showInSingleDictionary → bool
Whether or not to show this action in the single dictionary dropdown options.
finalinherited
uniqueKey → String
A unique name that allows distinguishing this type from others, particularly for the purposes of differentiating between persistent settings keys.
finalinherited

Methods

executeAction({required BuildContext context, required WidgetRef ref, required AppModel appModel, required CreatorModel creatorModel, required DictionaryHeading heading, required String? dictionaryName}) → Future<void>
Execute the functionality of this action.
override
getIconColor({required AppModel appModel, required DictionaryHeading heading}) → Future<Color?>
If non-null, sets a custom enabled color that this action should have for a certain condition in the application. By default, this is the foreground color.
inherited
getLocalisedDescription(AppModel appModel) → String
Get the best localisation for the description of this action. If there is no localisation, the fallback is description.
inherited
getLocalisedLabel(AppModel appModel) → String
Get the best localisation for the label of this action. If there is no localisation, the fallback is label.
inherited
initialise() → Future<void>
This function is run at startup or when changing languages. It is not called again if already run.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
prepareResources() → Future<void>
If an enhancement requires resources to function, they can be prepared here and this function will be run once only at runtime during the initialisation step.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

key → const String
Used to identify this enhancement and to allow a constant value for the default mappings value of AnkiMapping.
'play_audio'