feat: Add "Pin Widget" option to settings

This commit introduces a new "Pin Widget" option in the settings menu.

- A new menu item `settings_widget_icon` has been added to `settings_menu.xml`.
- A corresponding vector drawable `ic_widgets.xml` has been created for the icon.
- In `SettingsFragment.kt`:
    - Necessary imports for `AppWidgetManager`, `ComponentName`, and `PendingIntent` were added.
    - `handleOnClickWidgetOption()` function was implemented to handle the widget pinning request using `AppWidgetManager.requestPinAppWidget()`.
    - The `setOnMenuItemClickListener` in `setupListeners()` now handles the new `R.id.settings_widget_icon` to trigger `handleOnClickWidgetOption()`.
    - The `Uri.parse()` call for the language settings intent was updated to use the `String.toUri()` extension function.
- A new string resource `widget_icon` was added to `strings.xml`.

Author: JoshLudahl

app/src/main/java/com/warbler/ui/settings/SettingsFragment.kt

@@ -1,7 +1,9 @@
 package com.warbler.ui.settings
 
+import android.app.PendingIntent
+import android.appwidget.AppWidgetManager
+import android.content.ComponentName
 import android.content.Intent
-import android.net.Uri
 import android.os.Bundle
 import android.provider.Settings
 import android.view.View
@@ -12,8 +14,10 @@ import androidx.fragment.app.viewModels
 import androidx.navigation.findNavController
 import com.google.android.material.snackbar.Snackbar
 import com.google.firebase.crashlytics.internal.model.CrashlyticsReport.Session.Event.Log
+import com.warbler.MainActivity
 import com.warbler.R
 import com.warbler.databinding.FragmentSettingsBinding
+import com.warbler.ui.widget.WeatherWidgetProvider
 import com.warbler.utilities.Constants
 import dagger.hilt.android.AndroidEntryPoint
 
@@ -53,14 +57,19 @@ class SettingsFragment : Fragment(R.layout.fragment_settings) {
     private fun setupListeners() {
         binding.topAppBar.setOnMenuItemClickListener { menuItem ->
             when (menuItem.itemId) {
+                R.id.settings_widget_icon -> {
+                    handleOnClickWidgetOption()
+                    true
+                }
+
                 R.id.settings_share_icon -> {
                     handleShareClick(Constants.WEATHER_WARBLER_URL)
                     true
                 }
 
                 R.id.settings_language_icon -> {
                     val intent = Intent(Settings.ACTION_APPLICATION_DETAILS_SETTINGS)
-                    intent.data = Uri.parse("package:" + context?.packageName)
+                    intent.data = ("package:" + context?.packageName).toUri()
                     startActivity(intent)
                     true
                 }
@@ -191,6 +200,32 @@ class SettingsFragment : Fragment(R.layout.fragment_settings) {
         }
     }
 
+    private fun handleOnClickWidgetOption() {
+        val appWidgetManager = AppWidgetManager.getInstance(context)
+        val myProvider = ComponentName(requireContext(), WeatherWidgetProvider::class.java)
+        val intent = Intent(context, MainActivity::class.java)
+
+        if (appWidgetManager.isRequestPinAppWidgetSupported) {
+            // Create the PendingIntent object only if your app needs to be notified
+            // when the user chooses to pin the widget. Note that if the pinning
+            // operation fails, your app isn't notified. This callback receives the ID
+            // of the newly pinned widget (EXTRA_APPWIDGET_ID).
+            val successCallback =
+                PendingIntent.getBroadcast(
+                    // context =
+                    context,
+                    // requestCode =
+                    0,
+                    // intent =
+                    intent,
+                    // flags =
+                    PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE,
+                )
+
+            appWidgetManager.requestPinAppWidget(myProvider, null, successCallback)
+        }
+    }
+
     override fun onDestroyView() {
         super.onDestroyView()
         _binding = null

app/src/main/res/drawable/ic_widgets.xml

@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="960"
+    android:viewportHeight="960"
+    android:tint="@color/colorPrimary">
+  <path
+      android:fillColor="@android:color/white"
+      android:pathData="M638,492L468,322Q462,316 459.5,309Q457,302 457,294Q457,286 459.5,279Q462,272 468,266L638,96Q644,90 651,87.5Q658,85 666,85Q674,85 681,87.5Q688,90 694,96L864,266Q870,272 872.5,279Q875,286 875,294Q875,302 872.5,309Q870,316 864,322L694,492Q688,498 681,500.5Q674,503 666,503Q658,503 651,500.5Q644,498 638,492ZM120,400L120,160Q120,143 131.5,131.5Q143,120 160,120L400,120Q417,120 428.5,131.5Q440,143 440,160L440,400Q440,417 428.5,428.5Q417,440 400,440L160,440Q143,440 131.5,428.5Q120,417 120,400ZM520,800L520,560Q520,543 531.5,531.5Q543,520 560,520L800,520Q817,520 828.5,531.5Q840,543 840,560L840,800Q840,817 828.5,828.5Q817,840 800,840L560,840Q543,840 531.5,828.5Q520,817 520,800ZM120,800L120,560Q120,543 131.5,531.5Q143,520 160,520L400,520Q417,520 428.5,531.5Q440,543 440,560L440,800Q440,817 428.5,828.5Q417,840 400,840L160,840Q143,840 131.5,828.5Q120,817 120,800ZM200,360L360,360L360,200L200,200L200,360ZM667,408L780,295L667,182L554,295L667,408ZM600,760L760,760L760,600L600,600L600,760ZM200,760L360,760L360,600L200,600L200,760ZM360,360L360,360L360,360L360,360ZM554,295L554,295L554,295L554,295ZM360,600L360,600L360,600L360,600ZM600,600L600,600L600,600L600,600Z"/>
+</vector>

app/src/main/res/menu/settings_menu.xml

@@ -2,6 +2,15 @@
 <menu xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:app="http://schemas.android.com/apk/res-auto">
 
+    <item
+        android:id="@+id/settings_widget_icon"
+        android:contentDescription="@string/widget_icon"
+        android:icon="@drawable/ic_widgets"
+        android:title="@string/share_icon"
+        android:iconTint="@color/colorPrimary"
+        android:iconTintMode="screen"
+        app:showAsAction="ifRoom" />
+
     <item
         android:id="@+id/settings_language_icon"
         android:contentDescription="@string/share_icon"

app/src/main/res/values/strings.xml

@@ -121,4 +121,5 @@
     <!-- Widget strings -->
     <string name="refresh_weather" translatable="false">Refresh weather</string>
     <string name="weather_icon" translatable="false">Weather icon</string>
+    <string name="widget_icon" translatable="false">Widget Icon</string>
 </resources>