[DO NOT MERGE] Convert QSFactoryImpl to use @Multibinds (e9e3ebac) · Commits · e / os / android_frameworks_base

packages/SystemUI/docs/qs-tiles.md

+7 −3

Original line number	Original line	Diff line number	Diff line
	@@ -301,9 +301,13 @@ This section describes necessary and recommended steps when implementing a Quick
	* Use only `handleUpdateState` to modify the values of the state to the new ones. This can be done by polling controllers or through the `arg` parameter.		* Use only `handleUpdateState` to modify the values of the state to the new ones. This can be done by polling controllers or through the `arg` parameter.
	* If the controller is not a `CallbackController`, respond to `handleSetListening` by attaching/dettaching from controllers.		* If the controller is not a `CallbackController`, respond to `handleSetListening` by attaching/dettaching from controllers.
	* Implement `isAvailable` so the tile will not be created when it's not necessary.		* Implement `isAvailable` so the tile will not be created when it's not necessary.
	4. In `QSFactoryImpl`:		4. Either create a new feature module or find an existing related feature module and add the following binding method:
	* Inject a `Provider` for the tile created before.		* ```kotlin
	* Add a case to the `switch` with a unique String spec for the chosen tile.		@Binds
			@IntoMap
			@StringKey(YourNewTile.TILE_SPEC) // A unique word that will map to YourNewTile
			fun bindYourNewTile(yourNewTile: YourNewTile): QSTileImpl<*>
			```
	5. In [SystemUI/res/values/config.xml](/packages/SystemUI/res/values/config.xml), modify `quick_settings_tiles_stock` and add the spec defined in the previous step. If necessary, add it also to `quick_settings_tiles_default`. The first one contains a list of all the tiles that SystemUI knows how to create (to show to the user in the customization screen). The second one contains only the default tiles that the user will experience on a fresh boot or after they reset their tiles.		5. In [SystemUI/res/values/config.xml](/packages/SystemUI/res/values/config.xml), modify `quick_settings_tiles_stock` and add the spec defined in the previous step. If necessary, add it also to `quick_settings_tiles_default`. The first one contains a list of all the tiles that SystemUI knows how to create (to show to the user in the customization screen). The second one contains only the default tiles that the user will experience on a fresh boot or after they reset their tiles.
	6. In [SystemUI/res/values/tiles_states_strings.xml](/packages/SystemUI/res/values/tiles_states_strings.xml), add a new array for your tile. The name has to be `tile_states_<spec>`. Use a good description to help the translators.		6. In [SystemUI/res/values/tiles_states_strings.xml](/packages/SystemUI/res/values/tiles_states_strings.xml), add a new array for your tile. The name has to be `tile_states_<spec>`. Use a good description to help the translators.
	7. In [`SystemUI/src/com/android/systemui/qs/tileimpl/QSTileViewImpl.kt`](/packages/SystemUI/src/com/android/systemui/qs/tileimpl/QSTileViewImpl.kt), add a new element to the map in `SubtitleArrayMapping` corresponding to the resource created in the previous step.		7. In [`SystemUI/src/com/android/systemui/qs/tileimpl/QSTileViewImpl.kt`](/packages/SystemUI/src/com/android/systemui/qs/tileimpl/QSTileViewImpl.kt), add a new element to the map in `SubtitleArrayMapping` corresponding to the resource created in the previous step.

packages/SystemUI/src/com/android/systemui/accessibility/AccessibilityModule.kt

0 → 100644

+76 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2023 The Android Open Source Project
			*
			* Licensed under the Apache License, Version 2.0 (the "License");
			* you may not use this file except in compliance with the License.
			* You may obtain a copy of the License at
			*
			* http://www.apache.org/licenses/LICENSE-2.0
			*
			* Unless required by applicable law or agreed to in writing, software
			* distributed under the License is distributed on an "AS IS" BASIS,
			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
			* See the License for the specific language governing permissions and
			* limitations under the License.
			*/

			package com.android.systemui.accessibility

			import com.android.systemui.qs.tileimpl.QSTileImpl
			import com.android.systemui.qs.tiles.ColorCorrectionTile
			import com.android.systemui.qs.tiles.ColorInversionTile
			import com.android.systemui.qs.tiles.DreamTile
			import com.android.systemui.qs.tiles.FontScalingTile
			import com.android.systemui.qs.tiles.NightDisplayTile
			import com.android.systemui.qs.tiles.OneHandedModeTile
			import com.android.systemui.qs.tiles.ReduceBrightColorsTile
			import dagger.Binds
			import dagger.Module
			import dagger.multibindings.IntoMap
			import dagger.multibindings.StringKey

			@Module
			interface AccessibilityModule {

			/** Inject ColorInversionTile into tileMap in QSModule */
			@Binds
			@IntoMap
			@StringKey(ColorInversionTile.TILE_SPEC)
			fun bindColorInversionTile(colorInversionTile: ColorInversionTile): QSTileImpl<*>

			/** Inject NightDisplayTile into tileMap in QSModule */
			@Binds
			@IntoMap
			@StringKey(NightDisplayTile.TILE_SPEC)
			fun bindNightDisplayTile(nightDisplayTile: NightDisplayTile): QSTileImpl<*>

			/** Inject ReduceBrightColorsTile into tileMap in QSModule */
			@Binds
			@IntoMap
			@StringKey(ReduceBrightColorsTile.TILE_SPEC)
			fun bindReduceBrightColorsTile(reduceBrightColorsTile: ReduceBrightColorsTile): QSTileImpl<*>

			/** Inject OneHandedModeTile into tileMap in QSModule */
			@Binds
			@IntoMap
			@StringKey(OneHandedModeTile.TILE_SPEC)
			fun bindOneHandedModeTile(oneHandedModeTile: OneHandedModeTile): QSTileImpl<*>

			/** Inject ColorCorrectionTile into tileMap in QSModule */
			@Binds
			@IntoMap
			@StringKey(ColorCorrectionTile.TILE_SPEC)
			fun bindColorCorrectionTile(colorCorrectionTile: ColorCorrectionTile): QSTileImpl<*>

			/** Inject DreamTile into tileMap in QSModule */
			@Binds
			@IntoMap
			@StringKey(DreamTile.TILE_SPEC)
			fun bindDreamTile(dreamTile: DreamTile): QSTileImpl<*>

			/** Inject FontScalingTile into tileMap in QSModule */
			@Binds
			@IntoMap
			@StringKey(FontScalingTile.TILE_SPEC)
			fun bindFontScalingTile(fontScalingTile: FontScalingTile): QSTileImpl<*>
			}

packages/SystemUI/src/com/android/systemui/battery/BatterySaverModule.kt

0 → 100644

+34 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2023 The Android Open Source Project
			*
			* Licensed under the Apache License, Version 2.0 (the "License");
			* you may not use this file except in compliance with the License.
			* You may obtain a copy of the License at
			*
			* http://www.apache.org/licenses/LICENSE-2.0
			*
			* Unless required by applicable law or agreed to in writing, software
			* distributed under the License is distributed on an "AS IS" BASIS,
			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
			* See the License for the specific language governing permissions and
			* limitations under the License.
			*/

			package com.android.systemui.battery

			import com.android.systemui.qs.tileimpl.QSTileImpl
			import com.android.systemui.qs.tiles.BatterySaverTile
			import dagger.Binds
			import dagger.Module
			import dagger.multibindings.IntoMap
			import dagger.multibindings.StringKey

			@Module
			interface BatterySaverModule {

			/** Inject BatterySaverTile into tileMap in QSModule */
			@Binds
			@IntoMap
			@StringKey(BatterySaverTile.TILE_SPEC)
			fun bindBatterySaverTile(batterySaverTile: BatterySaverTile): QSTileImpl<*>
			}

packages/SystemUI/src/com/android/systemui/controls/dagger/ControlsModule.kt

+8 −0

Original line number	Original line	Diff line number	Diff line
	@@ -44,12 +44,15 @@ import com.android.systemui.controls.ui.ControlsActivity
	import com.android.systemui.controls.ui.ControlsUiController		import com.android.systemui.controls.ui.ControlsUiController
	import com.android.systemui.controls.ui.ControlsUiControllerImpl		import com.android.systemui.controls.ui.ControlsUiControllerImpl
	import com.android.systemui.dagger.SysUISingleton		import com.android.systemui.dagger.SysUISingleton
			import com.android.systemui.qs.tileimpl.QSTileImpl
			import com.android.systemui.qs.tiles.DeviceControlsTile
	import dagger.Binds		import dagger.Binds
	import dagger.BindsOptionalOf		import dagger.BindsOptionalOf
	import dagger.Module		import dagger.Module
	import dagger.Provides		import dagger.Provides
	import dagger.multibindings.ClassKey		import dagger.multibindings.ClassKey
	import dagger.multibindings.IntoMap		import dagger.multibindings.IntoMap
			import dagger.multibindings.StringKey

	/**		/**
	* Module for injecting classes in `com.android.systemui.controls`-		* Module for injecting classes in `com.android.systemui.controls`-
	@@ -149,4 +152,9 @@ abstract class ControlsModule {
	@IntoMap		@IntoMap
	@ClassKey(ControlsActivity::class)		@ClassKey(ControlsActivity::class)
	abstract fun provideControlsActivity(activity: ControlsActivity): Activity		abstract fun provideControlsActivity(activity: ControlsActivity): Activity

			@Binds
			@IntoMap
			@StringKey(DeviceControlsTile.TILE_SPEC)
			abstract fun bindDeviceControlsTile(controlsTile: DeviceControlsTile): QSTileImpl<*>
	}		}

packages/SystemUI/src/com/android/systemui/dagger/ReferenceSystemUIModule.java

+4 −0

Original line number	Original line	Diff line number	Diff line
	@@ -27,6 +27,7 @@ import androidx.annotation.Nullable;

	import com.android.internal.logging.UiEventLogger;		import com.android.internal.logging.UiEventLogger;
	import com.android.keyguard.KeyguardViewController;		import com.android.keyguard.KeyguardViewController;
			import com.android.systemui.battery.BatterySaverModule;
	import com.android.systemui.dagger.qualifiers.Main;		import com.android.systemui.dagger.qualifiers.Main;
	import com.android.systemui.dock.DockManager;		import com.android.systemui.dock.DockManager;
	import com.android.systemui.dock.DockManagerImpl;		import com.android.systemui.dock.DockManagerImpl;
	@@ -40,6 +41,7 @@ import com.android.systemui.qs.dagger.QSModule;
	import com.android.systemui.qs.tileimpl.QSFactoryImpl;		import com.android.systemui.qs.tileimpl.QSFactoryImpl;
	import com.android.systemui.recents.Recents;		import com.android.systemui.recents.Recents;
	import com.android.systemui.recents.RecentsImplementation;		import com.android.systemui.recents.RecentsImplementation;
			import com.android.systemui.rotationlock.RotationLockModule;
	import com.android.systemui.screenshot.ReferenceScreenshotModule;		import com.android.systemui.screenshot.ReferenceScreenshotModule;
	import com.android.systemui.shade.NotificationShadeWindowControllerImpl;		import com.android.systemui.shade.NotificationShadeWindowControllerImpl;
	import com.android.systemui.shade.ShadeController;		import com.android.systemui.shade.ShadeController;
	@@ -92,11 +94,13 @@ import dagger.Provides;
	*/		*/
	@Module(includes = {		@Module(includes = {
	AospPolicyModule.class,		AospPolicyModule.class,
			BatterySaverModule.class,
	GestureModule.class,		GestureModule.class,
	MediaModule.class,		MediaModule.class,
	PowerModule.class,		PowerModule.class,
	QSModule.class,		QSModule.class,
	ReferenceScreenshotModule.class,		ReferenceScreenshotModule.class,
			RotationLockModule.class,
	StartCentralSurfacesModule.class,		StartCentralSurfacesModule.class,
	VolumeModule.class		VolumeModule.class
	})		})