setting to enable/disable the tray animation

Author: martona

src/Settings.cpp

@@ -14,6 +14,7 @@ namespace {
     constexpr wchar_t kClipboardSyncMaxItemsName[] = L"ClipboardSyncMaxItems";
     constexpr wchar_t kHonorExternalPrivacyMarkersName[] = L"HonorExternalPrivacyMarkers";
     constexpr wchar_t kMaskShortTextPreviewsName[] = L"MaskShortTextPreviews";
+    constexpr wchar_t kAnimateFlowFeedbackName[] = L"AnimateFlowFeedback";
     constexpr wchar_t kOriginSequenceFloorName[] = L"OriginSequenceFloor";
     constexpr wchar_t kRegisterTtlSecondsName[] = L"RegisterTtlSeconds";
     constexpr wchar_t kRegisterMaxCountName[] = L"RegisterMaxCount";
@@ -54,6 +55,7 @@ Settings::Settings()
       clipboardSyncMaxItems_(DefaultClipboardSyncMaxItems),
       honorExternalPrivacyMarkers_(DefaultHonorExternalPrivacyMarkers),
       maskShortTextPreviews_(DefaultMaskShortTextPreviews),
+      animateFlowFeedback_(DefaultAnimateFlowFeedback),
       registerTtlSeconds_(DefaultRegisterTtlSeconds),
       registerMaxCount_(DefaultRegisterMaxCount) {
     LoadCache();
@@ -104,6 +106,11 @@ bool Settings::maskShortTextPreviews() const {
     return maskShortTextPreviews_;
 }
 
+bool Settings::animateFlowFeedback() const {
+    std::lock_guard<std::mutex> lock(mutex_);
+    return animateFlowFeedback_;
+}
+
 bool Settings::set_listenerIp(const std::string& value) {
     if (!IsValidListenerIp(value)) {
         return false;
@@ -191,6 +198,15 @@ bool Settings::set_maskShortTextPreviews(bool value) {
     return true;
 }
 
+bool Settings::set_animateFlowFeedback(bool value) {
+    if (!WriteUint32Value(kAnimateFlowFeedbackName, value ? 1 : 0)) {
+        return false;
+    }
+    std::lock_guard<std::mutex> lock(mutex_);
+    animateFlowFeedback_ = value;
+    return true;
+}
+
 uint64_t Settings::nextOriginSequenceNumber() {
     std::lock_guard<std::mutex> lock(mutex_);
     const uint64_t next = ++originSequenceCounter_;
@@ -301,6 +317,7 @@ bool Settings::LoadCache() {
     uint64_t clipboardSyncMaxItems = DefaultClipboardSyncMaxItems;
     int honorExternalPrivacyMarkers = DefaultHonorExternalPrivacyMarkers ? 1 : 0;
     int maskShortTextPreviews = DefaultMaskShortTextPreviews ? 1 : 0;
+    int animateFlowFeedback = DefaultAnimateFlowFeedback ? 1 : 0;
     uint64_t originSequenceFloor = 0;
 
     if (ReadStringValue(kListenerIpName, ip) && IsValidListenerIp(ip)) {
@@ -330,6 +347,9 @@ bool Settings::LoadCache() {
     if (ReadUint32Value(kMaskShortTextPreviewsName, maskShortTextPreviews)) {
         maskShortTextPreviews_ = (maskShortTextPreviews != 0);
     }
+    if (ReadUint32Value(kAnimateFlowFeedbackName, animateFlowFeedback)) {
+        animateFlowFeedback_ = (animateFlowFeedback != 0);
+    }
 
     // Origin sequence counter: load the persisted floor (the value the previous
     // session reserved through). Start the in-memory counter from there so we

src/Settings.h

@@ -38,6 +38,10 @@ class Settings {
     // single-token text (the might-be-a-password heuristic). Display-only —
     // never affects what syncs.
     static constexpr bool DefaultMaskShortTextPreviews = true;
+    // Default for animateFlowFeedback: nudge the tray / menu bar icon when a
+    // clipboard item is sent to or received from the group. Display-only; the
+    // last-event tooltip / menu line stays available either way.
+    static constexpr bool DefaultAnimateFlowFeedback = true;
 
     Settings();
 
@@ -53,6 +57,7 @@ class Settings {
     uint64_t clipboardSyncMaxItems() const;
     bool honorExternalPrivacyMarkers() const;
     bool maskShortTextPreviews() const;
+    bool animateFlowFeedback() const;
 
 	bool set_listenerIp(const std::string& value);
     bool set_tcpPort(int value);
@@ -63,6 +68,7 @@ class Settings {
     bool set_clipboardSyncMaxItems(uint64_t value);
     bool set_honorExternalPrivacyMarkers(bool value);
     bool set_maskShortTextPreviews(bool value);
+    bool set_animateFlowFeedback(bool value);
 
     // Atomically increments the per-origin sequence counter and returns the next
     // value. Persists every OriginSequenceBatchSize calls. On startup the counter
@@ -107,6 +113,7 @@ class Settings {
     uint64_t clipboardSyncMaxItems_;
     bool honorExternalPrivacyMarkers_;
     bool maskShortTextPreviews_;
+    bool animateFlowFeedback_;
     // In-memory origin sequence counter. Highest value yielded so far.
     uint64_t originSequenceCounter_{ 0 };
     // The next persisted floor — counter values up to (but not including) this

src/platform/macos/AppMenu.mm

@@ -5,6 +5,7 @@
 #include "Clipboard.h"
 #include "ClipboardFlowUi.h"
 #include "Logger.h"
+#include "Settings.h"
 #include "AboutPage.h"
 #include "ClippPage.h"
 #include "NetworkPage.h"
@@ -80,6 +81,7 @@ ClipboardPayload MakeTextClipboardPayload(NSString* text) {
 static ClippMainWindowController* g_logReflectorTarget = nil;
 extern ClipboardActivityStore g_clipboardActivityStore;
 extern PeerDisplay g_peerDisplay;
+extern Settings g_settings;
 
 static void LogReflectorCallback(const std::wstring& line);
 
@@ -1051,6 +1053,11 @@ - (void)noteClipboardFlowReceived:(BOOL)received peer:(NSString*)peer {
 }
 
 - (void)runNudgeReceived:(BOOL)received {
+    // Setting gates the MOTION only: noteClipboardFlowReceived already stored
+    // the event for the menu's last-event header.
+    if (!g_settings.animateFlowFeedback()) {
+        return;
+    }
     NSStatusBarButton* button = [self.statusItem button];
     if (button == nil || self.statusBaseImage == nil) {
         return;

src/platform/macos/SettingsPage.h

@@ -25,6 +25,7 @@ class MacOSSettingsPage {
     void OnResetHostID();
     void OnHonorPrivacyMarkersChanged();
     void OnMaskShortTextPreviewsChanged();
+    void OnAnimateFlowFeedbackChanged();
     void OnLaunchAtLoginChanged();
 
 private:
@@ -43,6 +44,8 @@ class MacOSSettingsPage {
     void ApplyClipboardHistorySettingChange();
     void RefreshPrivacyControls();
     void ApplyPrivacySettingChange();
+    void RefreshFeedbackControls();
+    void ApplyFeedbackSettingChange();
     void RefreshLaunchAtLoginControls();
     void ApplyLaunchAtLoginChange();
 
@@ -62,6 +65,7 @@ class MacOSSettingsPage {
     NSButton* resetHostIDButton_ = nullptr;
     NSButton* maskShortTextPreviewsCheckbox_ = nullptr;
     NSButton* honorPrivacyMarkersCheckbox_ = nullptr;
+    NSButton* animateFlowFeedbackCheckbox_ = nullptr;
     NSButton* launchAtLoginCheckbox_ = nullptr;
     NSTextField* statusMessage_ = nullptr;
     MacOSSettingsPageFieldDelegate* fieldDelegate_ = nullptr;

src/platform/macos/SettingsPage.mm

@@ -31,6 +31,7 @@ - (void)historySliderChanged:(id)sender;
 - (void)resetHostID:(id)sender;
 - (void)honorPrivacyMarkersChanged:(id)sender;
 - (void)maskShortTextPreviewsChanged:(id)sender;
+- (void)animateFlowFeedbackChanged:(id)sender;
 - (void)launchAtLoginChanged:(id)sender;
 @end
 
@@ -80,6 +81,13 @@ - (void)maskShortTextPreviewsChanged:(id)sender {
     }
 }
 
+- (void)animateFlowFeedbackChanged:(id)sender {
+    (void)sender;
+    if (owner_ != nullptr) {
+        owner_->OnAnimateFlowFeedbackChanged();
+    }
+}
+
 - (void)launchAtLoginChanged:(id)sender {
     (void)sender;
     if (owner_ != nullptr) {
@@ -368,6 +376,10 @@ uint64_t SliderStopValue(NSSlider* slider, const LimitStop(&stops)[N]) {
     ApplyPrivacySettingChange();
 }
 
+void MacOSSettingsPage::OnAnimateFlowFeedbackChanged() {
+    ApplyFeedbackSettingChange();
+}
+
 void MacOSSettingsPage::OnLaunchAtLoginChanged() {
     ApplyLaunchAtLoginChange();
 }
@@ -505,6 +517,36 @@ uint64_t SliderStopValue(NSSlider* slider, const LimitStop(&stops)[N]) {
         [privacyHelp.bottomAnchor constraintEqualToAnchor:privacySection.bottomAnchor constant:-kSectionInsetY],
     ]];
 
+    NSTextField* feedbackHeader = [NSTextField labelWithString:CLP_NS(CLP_UI_FEEDBACK)];
+    feedbackHeader.translatesAutoresizingMaskIntoConstraints = NO;
+    feedbackHeader.font = [NSFont systemFontOfSize:16 weight:NSFontWeightSemibold];
+    feedbackHeader.textColor = [NSColor labelColor];
+
+    NSBox* feedbackSection = MacOSMakeGroupBox();
+
+    animateFlowFeedbackCheckbox_ = [NSButton checkboxWithTitle:CLP_NS(CLP_UI_ANIMATE_FLOW_FEEDBACK)
+                                                        target:fieldDelegate_
+                                                        action:@selector(animateFlowFeedbackChanged:)];
+    animateFlowFeedbackCheckbox_.translatesAutoresizingMaskIntoConstraints = NO;
+    [feedbackSection addSubview:animateFlowFeedbackCheckbox_];
+
+    NSTextField* animateHelp = MacOSMakeWrappingLabel(CLP_NS(CLP_UI_ANIMATE_FLOW_FEEDBACK_HELP),
+                                                      12.0,
+                                                      [NSColor secondaryLabelColor]);
+    [feedbackSection addSubview:animateHelp];
+
+    NSMutableArray<NSLayoutConstraint*>* feedbackConstraints = [NSMutableArray array];
+    [feedbackConstraints addObjectsFromArray:@[
+        [animateFlowFeedbackCheckbox_.leadingAnchor constraintEqualToAnchor:feedbackSection.leadingAnchor constant:kSectionInsetX],
+        [animateFlowFeedbackCheckbox_.trailingAnchor constraintLessThanOrEqualToAnchor:feedbackSection.trailingAnchor constant:-kSectionInsetX],
+        [animateFlowFeedbackCheckbox_.topAnchor constraintEqualToAnchor:feedbackSection.topAnchor constant:kSectionInsetY],
+
+        [animateHelp.leadingAnchor constraintEqualToAnchor:feedbackSection.leadingAnchor constant:kSectionInsetX],
+        [animateHelp.trailingAnchor constraintEqualToAnchor:feedbackSection.trailingAnchor constant:-kSectionInsetX],
+        [animateHelp.topAnchor constraintEqualToAnchor:animateFlowFeedbackCheckbox_.bottomAnchor constant:6.0],
+        [animateHelp.bottomAnchor constraintEqualToAnchor:feedbackSection.bottomAnchor constant:-kSectionInsetY],
+    ]];
+
     NSTextField* hostIDHeader = [NSTextField labelWithString:CLP_NS(CLP_UI_HOST_ID)];
     hostIDHeader.translatesAutoresizingMaskIntoConstraints = NO;
     hostIDHeader.font = [NSFont systemFontOfSize:16 weight:NSFontWeightSemibold];
@@ -534,6 +576,8 @@ uint64_t SliderStopValue(NSSlider* slider, const LimitStop(&stops)[N]) {
     [contentRoot addSubview:historySection];
     [contentRoot addSubview:privacyHeader];
     [contentRoot addSubview:privacySection];
+    [contentRoot addSubview:feedbackHeader];
+    [contentRoot addSubview:feedbackSection];
     [contentRoot addSubview:networkHeader];
     [contentRoot addSubview:section];
     [contentRoot addSubview:hostIDHeader];
@@ -587,9 +631,17 @@ uint64_t SliderStopValue(NSSlider* slider, const LimitStop(&stops)[N]) {
         [privacySection.trailingAnchor constraintEqualToAnchor:heading.trailingAnchor],
         [privacySection.topAnchor constraintEqualToAnchor:privacyHeader.bottomAnchor constant:16.0],
 
+        [feedbackHeader.leadingAnchor constraintEqualToAnchor:heading.leadingAnchor],
+        [feedbackHeader.trailingAnchor constraintEqualToAnchor:heading.trailingAnchor],
+        [feedbackHeader.topAnchor constraintEqualToAnchor:privacySection.bottomAnchor constant:18.0],
+
+        [feedbackSection.leadingAnchor constraintEqualToAnchor:heading.leadingAnchor],
+        [feedbackSection.trailingAnchor constraintEqualToAnchor:heading.trailingAnchor],
+        [feedbackSection.topAnchor constraintEqualToAnchor:feedbackHeader.bottomAnchor constant:16.0],
+
         [networkHeader.leadingAnchor constraintEqualToAnchor:heading.leadingAnchor],
         [networkHeader.trailingAnchor constraintEqualToAnchor:heading.trailingAnchor],
-        [networkHeader.topAnchor constraintEqualToAnchor:privacySection.bottomAnchor constant:18.0],
+        [networkHeader.topAnchor constraintEqualToAnchor:feedbackSection.bottomAnchor constant:18.0],
 
         [section.leadingAnchor constraintEqualToAnchor:heading.leadingAnchor],
         [section.trailingAnchor constraintEqualToAnchor:heading.trailingAnchor],
@@ -626,6 +678,7 @@ uint64_t SliderStopValue(NSSlider* slider, const LimitStop(&stops)[N]) {
     [NSLayoutConstraint activateConstraints:historyConstraints];
     [NSLayoutConstraint activateConstraints:rowConstraints];
     [NSLayoutConstraint activateConstraints:privacyConstraints];
+    [NSLayoutConstraint activateConstraints:feedbackConstraints];
     [NSLayoutConstraint activateConstraints:hostIDConstraints];
 }
 
@@ -639,6 +692,7 @@ uint64_t SliderStopValue(NSSlider* slider, const LimitStop(&stops)[N]) {
     MacOSSetFieldText(listenerIpField_, g_settings.listenerIp());
     RefreshClipboardHistoryControls();
     RefreshPrivacyControls();
+    RefreshFeedbackControls();
     RefreshLaunchAtLoginControls();
     loadingSettings_ = false;
 
@@ -816,6 +870,33 @@ uint64_t SliderStopValue(NSSlider* slider, const LimitStop(&stops)[N]) {
     ShowStatusMessage();
 }
 
+void MacOSSettingsPage::RefreshFeedbackControls() {
+    if (animateFlowFeedbackCheckbox_ == nil) {
+        return;
+    }
+
+    animateFlowFeedbackCheckbox_.state = g_settings.animateFlowFeedback()
+        ? NSControlStateValueOn
+        : NSControlStateValueOff;
+}
+
+void MacOSSettingsPage::ApplyFeedbackSettingChange() {
+    if (loadingSettings_ || animateFlowFeedbackCheckbox_ == nil) {
+        return;
+    }
+
+    const bool desiredAnimate = animateFlowFeedbackCheckbox_.state == NSControlStateValueOn;
+    if (desiredAnimate == g_settings.animateFlowFeedback()) {
+        return;
+    }
+    if (!g_settings.set_animateFlowFeedback(desiredAnimate)) {
+        return;
+    }
+
+    MacOSSetFieldText(statusMessage_, CLP_NS(CLP_UI_FEEDBACK_SETTINGS_APPLIED));
+    ShowStatusMessage();
+}
+
 void MacOSSettingsPage::RefreshLaunchAtLoginControls() {
     if (launchAtLoginCheckbox_ == nil) {
         return;

src/platform/uistrings.h

@@ -92,6 +92,11 @@
 #define CLP_UI_HONOR_PRIVACY_MARKERS_HELP "When other apps mark clipboard items as private (passwords from Chrome, password managers, etc.), Clipp will not sync the content to your other devices."
 #define CLP_UI_PRIVACY_SETTINGS_APPLIED "Privacy settings applied."
 
+#define CLP_UI_FEEDBACK "Feedback"
+#define CLP_UI_ANIMATE_FLOW_FEEDBACK "Animate the Clipp icon on send and receive"
+#define CLP_UI_ANIMATE_FLOW_FEEDBACK_HELP "The status icon gives a quick nudge whenever a copied item leaves for your other devices or arrives from one."
+#define CLP_UI_FEEDBACK_SETTINGS_APPLIED "Feedback setting applied."
+
 // Mac App Store flavor only (guideline 2.4.5(iii)): login items there require
 // explicit consent, so the MAS build swaps autostart-by-default for this toggle.
 #define CLP_UI_STARTUP "Startup"