makiolaj/calendula
1
0
Fork 1
Code Actions Releases 32 Activity

Fix the agenda widget's misplaced and stale KDoc (#214)

Browse Source
This commit is contained in:
Jean-Luc Makiola
2026-08-17 21:32:29 +02:00
parent d8e06f059c
commit c7375c28d8
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
app/src/main/java/de/jeanlucmakiola/calendula/widget/agenda/AgendaWidget.kt
View File

@@ -74,11 +74,6 @@ import kotlinx.datetime.toLocalDateTime
import kotlin.time.Instant import kotlin.time.Instant
import java.util.Locale import java.util.Locale
/**
* "Upcoming" agenda widget — a continuously scrolling list of the next ~30 days
* of events grouped under day headers (the Google "Schedule" widget model).
* Reuses the app's [groupAgendaDays] grouping so it matches the in-app agenda.
*/
/** /**
* Per-instance Glance state key holding the agenda range (as [AgendaRange.storageValue]). * Per-instance Glance state key holding the agenda range (as [AgendaRange.storageValue]).
* The range is read reactively in the composition ([currentState]) so a settings * The range is read reactively in the composition ([currentState]) so a settings
@@ -113,6 +108,11 @@ internal val AGENDA_SHOW_TODAY_STATE_KEY = booleanPreferencesKey("agenda_show_to
*/ */
internal val AGENDA_SIZE_KEY = stringPreferencesKey("widget_size") internal val AGENDA_SIZE_KEY = stringPreferencesKey("widget_size")
/**
* "Upcoming" agenda widget — a continuously scrolling list of the next ~30 days
* of events grouped under day headers (the Google "Schedule" widget model).
* Reuses the app's [groupAgendaDays] grouping so it matches the in-app agenda.
*/
class AgendaWidget : GlanceAppWidget() { class AgendaWidget : GlanceAppWidget() {
override val stateDefinition = PreferencesGlanceStateDefinition override val stateDefinition = PreferencesGlanceStateDefinition
@@ -136,9 +136,11 @@ class AgendaWidget : GlanceAppWidget() {
} }
/** /**
* Re-reads the calendar and redraws the widget (header refresh button). Targets * Redraws the widget (header refresh button). Targets the tapped widget's own id
* the tapped widget's own id rather than `updateAll`, whose provider-name lookup * rather than `updateAll`, whose provider-name lookup is empty in a process a tap
* is empty in a process a tap woke from cold — see `ShiftMonthAction` (#18). * woke from cold — see `ShiftMonthAction` (#18). A cold process re-reads the
* calendar in the `provideGlance` preamble; a live session only recomposes from
* the snapshot it already has (see [AGENDA_RANGE_KEY]).
*/ */
class RefreshAgendaAction : ActionCallback { class RefreshAgendaAction : ActionCallback {
override suspend fun onAction(context: Context, glanceId: GlanceId, parameters: ActionParameters) { override suspend fun onAction(context: Context, glanceId: GlanceId, parameters: ActionParameters) {
@@ -149,7 +151,7 @@ class RefreshAgendaAction : ActionCallback {
/** /**
* Upper bound on rows handed to the [LazyColumn], so the serialized RemoteViews * Upper bound on rows handed to the [LazyColumn], so the serialized RemoteViews
* stays well inside the binder transaction limit regardless of range and calendar * stays well inside the binder transaction limit regardless of range and calendar
* size (see the [SizeMode.Exact] note above). Far more than fits on screen — a * size (see the [SizeMode.Single] note above). Far more than fits on screen — a
* user scrolling a home-screen widget past a hundred rows is not a case worth * user scrolling a home-screen widget past a hundred rows is not a case worth
* risking a failed update for. * risking a failed update for.
*/ */