page up/down for non-bulk candidates

Author: eagleoflqj

uipanel/CandidateBar.swift

@@ -86,7 +86,7 @@ struct CandidateBarView: View {
                     }
                   }.onAppear {
                     visibleRows.insert(row)
-                    if !scrollEnd && row == rowItemCount.count - 5 {
+                    if pendingScroll >= 0 && !scrollEnd && row == rowItemCount.count - 5 {
                       loadMoreCandidates(candidates.count, candidateCountInScreen)
                     }
                   }.onDisappear {
@@ -107,7 +107,9 @@ struct CandidateBarView: View {
                   CandidateView(
                     text: candidate, index: index, highlighted: highlighted
                   ).onAppear {
-                    if !scrollEnd && index == candidates.count - candidateCountInRow {
+                    if pendingScroll >= 0 && !scrollEnd
+                      && index == candidates.count - candidateCountInRow
+                    {
                       loadMoreCandidates(candidates.count, candidateCountInRow)
                     }
                   }
@@ -150,8 +152,12 @@ struct CandidateBarView: View {
                 shadow: getShadow(colorScheme),
                 action: GestureAction(
                   onTap: {
-                    withAnimation {
-                      proxy.scrollTo(((visibleRows.min() ?? 0) - 1) / 5 * 5, anchor: .top)
+                    if pendingScroll >= 0 {
+                      withAnimation {
+                        proxy.scrollTo(((visibleRows.min() ?? 0) - 1) / 5 * 5, anchor: .top)
+                      }
+                    } else {
+                      page(false)
                     }
                   }
                 )
@@ -169,8 +175,12 @@ struct CandidateBarView: View {
                 shadow: getShadow(colorScheme),
                 action: GestureAction(
                   onTap: {
-                    withAnimation {
-                      proxy.scrollTo(((visibleRows.min() ?? 0) + 1) / 5 * 5 + 5, anchor: .top)
+                    if pendingScroll >= 0 {
+                      withAnimation {
+                        proxy.scrollTo(((visibleRows.min() ?? 0) + 1) / 5 * 5 + 5, anchor: .top)
+                      }
+                    } else {
+                      page(true)
                     }
                   }
                 )

uipanel/VirtualKeyboard.swift

@@ -24,7 +24,7 @@ class ViewModel: ObservableObject {
   @Published var scrollEnd = false
   @Published var rowItemCount = [Int]()  // number of candidates in each row
   @Published var expanded = false
-  // Have requested load more candidates starting from this index.
+  // Have requested load more candidates starting from this index. -1 means not scrollable.
   @Published var pendingScroll = 0
 
   @Published var actions = [StatusAreaAction]()
@@ -131,7 +131,7 @@ public struct VirtualKeyboardView: View {
 
   public func setCandidates(
     _ auxUp: String, _ preedit: String, _ caret: Int32, _ candidates: [String],
-    _ highlighted: Int32, _ hasClientPreedit: Bool
+    _ highlighted: Int32, _ bulk: Bool, _ hasClientPreedit: Bool
   ) {
     if !auxUp.isEmpty || !preedit.isEmpty || !candidates.isEmpty {
       setDisplayMode(.candidates)
@@ -152,7 +152,7 @@ public struct VirtualKeyboardView: View {
     viewModel.batch = (viewModel.batch + 1) & 0xFFFF
     viewModel.scrollEnd = false
     viewModel.rowItemCount = calculateLayout(candidates, keyboardWidth * 4 / 5)
-    viewModel.pendingScroll = 0
+    viewModel.pendingScroll = bulk ? 0 : -1
   }
 
   public func scroll(_ candidates: [String], _ end: Bool) {

uipanel/keyboardui.swift

@@ -15,11 +15,11 @@ public func showKeyboardAsync(_ clientPtr: UnsafeMutableRawPointer) {
 
 public func setCandidatesAsync(
   _ auxUp: String, _ preedit: String, _ caret: Int32, _ candidates: [String],
-  _ highlighted: Int32, _ hasClientPreedit: Bool
+  _ highlighted: Int32, _ bulk: Bool, _ hasClientPreedit: Bool
 ) {
   DispatchQueue.main.async {
     virtualKeyboardView.setCandidates(
-      auxUp, preedit, caret, candidates, highlighted, hasClientPreedit)
+      auxUp, preedit, caret, candidates, highlighted, bulk, hasClientPreedit)
   }
 }
 

uipanel/uipanel-public.h

@@ -7,3 +7,4 @@ void activateCandidateAction(int index, int id);
 void selectCandidate(int index);
 void activateStatusAreaAction(int id);
 void scroll(int start, int count);
+void page(bool next);

uipanel/uipanel.cpp

@@ -63,7 +63,7 @@ void UIPanel::update(UserInterfaceComponent component,
             highlighted = list->cursorIndex();
         }
         KeyboardUI::setCandidatesAsync(auxUp, preedit, caret, candidates,
-                                       highlighted, hasClientPreedit);
+                                       highlighted, false, hasClientPreedit);
         break;
     }
     case UserInterfaceComponent::StatusArea:
@@ -110,7 +110,7 @@ void UIPanel::expand(const std::string &auxUp, const std::string &preedit,
                      int caret, bool hasClientPreedit) {
     auto candidates =
         getBulkCandidates(instance_, 0, 72); // Vertically 2 screens.
-    KeyboardUI::setCandidatesAsync(auxUp, preedit, caret, candidates, 0,
+    KeyboardUI::setCandidatesAsync(auxUp, preedit, caret, candidates, 0, true,
                                    hasClientPreedit);
 }
 
@@ -120,6 +120,19 @@ void UIPanel::scroll(int start, int count) {
     KeyboardUI::scrollAsync(candidates, endReached);
 }
 
+void UIPanel::page(bool next) {
+    auto ic = instance_->mostRecentInputContext();
+    const auto &list = ic->inputPanel().candidateList();
+    if (!list)
+        return;
+    auto *pageableList = list->toPageable();
+    if (!pageableList)
+        return;
+    next ? pageableList->next() : pageableList->prev();
+    // UI is responsible for updating UI
+    ic->updateUserInterface(UserInterfaceComponent::InputPanel);
+}
+
 KeyboardUI::StatusAreaAction convertAction(Action *action, InputContext *ic) {
     auto children = swift::Array<KeyboardUI::StatusAreaAction>::init();
     if (auto *menu = action->menu()) {
@@ -165,6 +178,10 @@ void scroll(int start, int count) {
     dispatcher->schedule([start, count] { fcitx::ui->scroll(start, count); });
 }
 
+void page(bool next) {
+    dispatcher->schedule([next] { fcitx::ui->page(next); });
+}
+
 std::string getCandidateActions(int index) {
     return with_fcitx([index]() -> std::string {
         auto ic = instance->mostRecentInputContext();

uipanel/uipanel.h

@@ -29,6 +29,7 @@ class UIPanel final : public VirtualKeyboardUserInterface {
     void showVirtualKeyboard() override;
     void hideVirtualKeyboard() override {}
     void scroll(int start, int count);
+    void page(bool next);
 
   private:
     Instance *instance_;