Skip to content

Commit b6d4421

Browse files
NiffirgkcaJNiffirgkcaJ
committed
Refactor: Aligned the history and pinned naming scheme of the clipboard function.
1 parent c861310 commit b6d4421

5 files changed

Lines changed: 53 additions & 53 deletions

File tree

‎gnome-extensions/extension/features/Clipboard/managers/clipboardManager.js‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ const CLIPBOARD_HISTORY_MAX_ITEMS_KEY = 'clipboard-history-max-items';
2121
* Delegates content routing to ClipboardContentRouterService and clipboard I/O to ClipboardCopyService.
2222
*
2323
* @emits history-changed Emitted when the clipboard history changes.
24-
* @emits pinned-list-changed Emitted when the pinned items list changes.
24+
* @emits pinned-changed Emitted when the pinned items list changes.
2525
*/
2626
export const ClipboardManager = GObject.registerClass(
2727
{
2828
Signals: {
2929
'history-changed': {},
30-
'pinned-list-changed': {},
30+
'pinned-changed': {},
3131
},
3232
},
3333
class ClipboardManager extends GObject.Object {
@@ -96,7 +96,7 @@ export const ClipboardManager = GObject.registerClass(
9696
this._pinned = data.pinned;
9797

9898
this.emit('history-changed');
99-
this.emit('pinned-list-changed');
99+
this.emit('pinned-changed');
100100

101101
this._monitor.start();
102102

@@ -106,7 +106,7 @@ export const ClipboardManager = GObject.registerClass(
106106
if (changed) {
107107
this._saveAll();
108108
this.emit('history-changed');
109-
this.emit('pinned-list-changed');
109+
this.emit('pinned-changed');
110110
}
111111
})
112112
.catch((e) => {
@@ -224,7 +224,7 @@ export const ClipboardManager = GObject.registerClass(
224224

225225
this._saveAll();
226226
this.emit('history-changed');
227-
this.emit('pinned-list-changed');
227+
this.emit('pinned-changed');
228228
}
229229
}
230230

@@ -325,7 +325,7 @@ export const ClipboardManager = GObject.registerClass(
325325

326326
this._saveAll();
327327
this.emit('history-changed');
328-
this.emit('pinned-list-changed');
328+
this.emit('pinned-changed');
329329
}
330330

331331
/**
@@ -348,7 +348,7 @@ export const ClipboardManager = GObject.registerClass(
348348
if (changed) {
349349
this._saveAll();
350350
this.emit('history-changed');
351-
this.emit('pinned-list-changed');
351+
this.emit('pinned-changed');
352352
}
353353
}
354354

@@ -367,7 +367,7 @@ export const ClipboardManager = GObject.registerClass(
367367

368368
this._saveAll();
369369
this.emit('history-changed');
370-
this.emit('pinned-list-changed');
370+
this.emit('pinned-changed');
371371
}
372372

373373
/**
@@ -391,7 +391,7 @@ export const ClipboardManager = GObject.registerClass(
391391
this._storage.pruneHistory(this._history);
392392
this._saveAll();
393393
this.emit('history-changed');
394-
this.emit('pinned-list-changed');
394+
this.emit('pinned-changed');
395395
}
396396
}
397397

@@ -439,7 +439,7 @@ export const ClipboardManager = GObject.registerClass(
439439
if (wasDeleted) {
440440
this._saveAll();
441441
this.emit('history-changed');
442-
this.emit('pinned-list-changed');
442+
this.emit('pinned-changed');
443443
}
444444
}
445445

@@ -469,7 +469,7 @@ export const ClipboardManager = GObject.registerClass(
469469
if (wasDeleted) {
470470
this._saveAll();
471471
this.emit('history-changed');
472-
this.emit('pinned-list-changed');
472+
this.emit('pinned-changed');
473473
}
474474
}
475475

@@ -492,7 +492,7 @@ export const ClipboardManager = GObject.registerClass(
492492
this._pinned = [];
493493

494494
this._savePinned();
495-
this.emit('pinned-list-changed');
495+
this.emit('pinned-changed');
496496
}
497497

498498
/**

‎gnome-extensions/extension/features/Clipboard/tabClipboard.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ export const ClipboardTabContent = GObject.registerClass(
311311
this._manager.connectObject(
312312
'history-changed',
313313
() => this._scheduleRedraw(),
314-
'pinned-list-changed',
314+
'pinned-changed',
315315
() => this._scheduleRedraw(),
316316
this,
317317
);

gnome-extensions/extension/features/RecentlyUsed/definitions/recentlyUsedDefinitionClipboard.js renamed to gnome-extensions/extension/features/RecentlyUsed/definitions/recentlyUsedDefinitionClipboardHistory.js

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ import { ClipboardSearchUtils } from '../../Clipboard/utilities/clipboardSearchU
1010
import { ensureClipboardSearchProviderRegistered } from '../../Clipboard/integrations/clipboardSearchProvider.js';
1111

1212
/**
13-
* Creates a runtime-scoped clipboard section definition.
13+
* Creates a runtime-scoped clipboard history section definition.
1414
*
15-
* @returns {object} Clipboard section definition instance.
15+
* @returns {object} Clipboard history section definition instance.
1616
*/
17-
function createRecentlyUsedDefinitionClipboardInstance() {
17+
function createRecentlyUsedDefinitionClipboardHistoryInstance() {
1818
const definition = new RecentlyUsedSectionDefinition({
19-
id: 'clipboard',
19+
id: 'clipboard-history',
2020
targetTab: 'Clipboard',
2121
layoutType: 'list',
2222
source: {
@@ -41,19 +41,19 @@ function createRecentlyUsedDefinitionClipboardInstance() {
4141
});
4242

4343
/**
44-
* Initializes the clipboard section.
44+
* Initializes the clipboard history section.
4545
*/
4646
definition.initialize = () => {
4747
ensureClipboardSearchProviderRegistered();
4848
};
4949

5050
/**
51-
* Cleans up clipboard section resources.
51+
* Cleans up clipboard history section resources.
5252
*/
5353
definition.destroy = () => {};
5454

5555
/**
56-
* Returns signals that trigger clipboard section updates.
56+
* Returns signals that trigger clipboard history section updates.
5757
*
5858
* @param {object} params Context object.
5959
* @param {object} params.extension Extension instance.
@@ -67,7 +67,7 @@ function createRecentlyUsedDefinitionClipboardInstance() {
6767
};
6868

6969
/**
70-
* Indicates whether the clipboard section is enabled.
70+
* Indicates whether the clipboard history section is enabled.
7171
*
7272
* @param {object} params Context object.
7373
* @param {object} params.settings Extension settings object.
@@ -82,20 +82,20 @@ function createRecentlyUsedDefinitionClipboardInstance() {
8282
*
8383
* @param {object} params Context object.
8484
* @param {object} params.extension Extension instance.
85-
* @returns {Array<object>} Clipboard items.
85+
* @returns {Array<object>} Clipboard history items.
8686
*/
8787
definition.getItems = ({ extension }) => {
8888
const clipboardManager = extension?._clipboardManager;
8989
return clipboardManager?.getHistoryItems?.() || [];
9090
};
9191

9292
/**
93-
* Searches clipboard history through the shared Search Hub provider.
93+
* Searches clipboard history items through the shared Search Hub provider.
9494
*
9595
* @param {object} params Search context.
9696
* @param {string} params.query Normalized search query.
9797
* @param {object} params.runtimeContext Runtime context.
98-
* @returns {Promise<Array<object>>} Matching clipboard history entries.
98+
* @returns {Promise<Array<object>>} Matching clipboard history items.
9999
*/
100100
definition.searchItems = async ({ query, runtimeContext }) => {
101101
if (!query) {
@@ -128,13 +128,13 @@ function createRecentlyUsedDefinitionClipboardInstance() {
128128
};
129129

130130
/**
131-
* Matches clipboard entries using Clipboard tab search behavior.
131+
* Matches clipboard history items using Clipboard tab search behavior.
132132
*
133133
* @param {object} params Search context.
134134
* @param {object} params.item Candidate item.
135135
* @param {string} params.query Normalized search query.
136136
* @param {Function} params.fallbackMatch Generic fallback matcher.
137-
* @returns {boolean} True when the clipboard item matches search.
137+
* @returns {boolean} True when the clipboard history item matches search.
138138
*/
139139
definition.matchesSearch = ({ item, query, fallbackMatch }) => {
140140
if (!query) {
@@ -163,7 +163,7 @@ function createRecentlyUsedDefinitionClipboardInstance() {
163163
};
164164

165165
/**
166-
* Handles clicks by copying and promoting clipboard items.
166+
* Handles clicks by copying and promoting clipboard history items.
167167
*
168168
* @param {object} params Click context.
169169
* @returns {Promise<boolean>} True when copy succeeds.
@@ -181,12 +181,12 @@ function createRecentlyUsedDefinitionClipboardInstance() {
181181
});
182182
};
183183

184-
definition.createInstance = () => createRecentlyUsedDefinitionClipboardInstance();
184+
definition.createInstance = () => createRecentlyUsedDefinitionClipboardHistoryInstance();
185185

186186
return definition;
187187
}
188188

189189
/**
190190
* Section definition template for clipboard history items.
191191
*/
192-
export const RecentlyUsedDefinitionClipboard = () => createRecentlyUsedDefinitionClipboardInstance();
192+
export const RecentlyUsedDefinitionClipboardHistory = () => createRecentlyUsedDefinitionClipboardHistoryInstance();

gnome-extensions/extension/features/RecentlyUsed/definitions/recentlyUsedDefinitionPinned.js renamed to gnome-extensions/extension/features/RecentlyUsed/definitions/recentlyUsedDefinitionClipboardPinned.js

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ import { ClipboardSearchUtils } from '../../Clipboard/utilities/clipboardSearchU
1111
import { ensureClipboardSearchProviderRegistered } from '../../Clipboard/integrations/clipboardSearchProvider.js';
1212

1313
/**
14-
* Creates a runtime-scoped pinned section definition.
14+
* Creates a runtime-scoped clipboard pinned section definition.
1515
*
16-
* @returns {object} Pinned section definition instance.
16+
* @returns {object} Clipboard pinned section definition instance.
1717
*/
18-
function createRecentlyUsedDefinitionPinnedInstance() {
18+
function createRecentlyUsedDefinitionClipboardPinnedInstance() {
1919
const definition = new RecentlyUsedSectionDefinition({
20-
id: 'pinned',
20+
id: 'clipboard-pinned',
2121
targetTab: 'Clipboard',
2222
layoutType: 'list',
2323
defaultPolicy: {
@@ -55,14 +55,14 @@ function createRecentlyUsedDefinitionPinnedInstance() {
5555
});
5656

5757
/**
58-
* Initializes the pinned section.
58+
* Initializes the clipboard pinned section.
5959
*/
6060
definition.initialize = () => {
6161
ensureClipboardSearchProviderRegistered();
6262
};
6363

6464
/**
65-
* Cleans up pinned section resources.
65+
* Cleans up clipboard pinned section resources.
6666
*/
6767
definition.destroy = () => {};
6868

@@ -77,35 +77,35 @@ function createRecentlyUsedDefinitionPinnedInstance() {
7777
definition.getSignals = ({ extension, onRender }) => {
7878
const clipboardManager = extension?._clipboardManager;
7979
if (!clipboardManager) return [];
80-
return [{ obj: clipboardManager, id: clipboardManager.connect('pinned-list-changed', onRender) }];
80+
return [{ obj: clipboardManager, id: clipboardManager.connect('pinned-changed', onRender) }];
8181
};
8282

8383
/**
84-
* Indicates whether this section is enabled.
84+
* Indicates whether the clipboard pinned section is enabled.
8585
*
86-
* @returns {boolean} Always true for pinned items.
86+
* @returns {boolean} Always true for clipboard pinned items.
8787
*/
8888
definition.isEnabled = () => true;
8989

9090
/**
91-
* Returns pinned clipboard items.
91+
* Returns clipboard pinned items.
9292
*
9393
* @param {object} params Context object.
9494
* @param {object} params.extension Extension instance.
95-
* @returns {Array<object>} Pinned clipboard entries.
95+
* @returns {Array<object>} Clipboard pinned items.
9696
*/
9797
definition.getItems = ({ extension }) => {
9898
const clipboardManager = extension?._clipboardManager;
9999
return clipboardManager?.getPinnedItems?.() || [];
100100
};
101101

102102
/**
103-
* Searches pinned clipboard items through the shared Search Hub provider.
103+
* Searches clipboard pinned items through the shared Search Hub provider.
104104
*
105105
* @param {object} params Search context.
106106
* @param {string} params.query Normalized search query.
107107
* @param {object} params.runtimeContext Runtime context.
108-
* @returns {Promise<Array<object>>} Matching pinned entries.
108+
* @returns {Promise<Array<object>>} Matching clipboard pinned items.
109109
*/
110110
definition.searchItems = async ({ query, runtimeContext }) => {
111111
if (!query) {
@@ -138,13 +138,13 @@ function createRecentlyUsedDefinitionPinnedInstance() {
138138
};
139139

140140
/**
141-
* Matches pinned clipboard entries using Clipboard tab search behavior.
141+
* Matches clipboard pinned items using Clipboard tab search behavior.
142142
*
143143
* @param {object} params Search context.
144144
* @param {object} params.item Candidate item.
145145
* @param {string} params.query Normalized search query.
146146
* @param {Function} params.fallbackMatch Generic fallback matcher.
147-
* @returns {boolean} True when the pinned item matches search.
147+
* @returns {boolean} True when the clipboard pinned item matches search.
148148
*/
149149
definition.matchesSearch = ({ item, query, fallbackMatch }) => {
150150
if (!query) {
@@ -173,7 +173,7 @@ function createRecentlyUsedDefinitionPinnedInstance() {
173173
};
174174

175175
/**
176-
* Handles clicks by copying and promoting pinned items.
176+
* Handles clicks by copying and promoting clipboard pinned items.
177177
*
178178
* @param {object} params Click context.
179179
* @returns {Promise<boolean>} True when copy succeeds.
@@ -191,12 +191,12 @@ function createRecentlyUsedDefinitionPinnedInstance() {
191191
});
192192
};
193193

194-
definition.createInstance = () => createRecentlyUsedDefinitionPinnedInstance();
194+
definition.createInstance = () => createRecentlyUsedDefinitionClipboardPinnedInstance();
195195

196196
return definition;
197197
}
198198

199199
/**
200200
* Section definition template for clipboard pinned items.
201201
*/
202-
export const RecentlyUsedDefinitionPinned = () => createRecentlyUsedDefinitionPinnedInstance();
202+
export const RecentlyUsedDefinitionClipboardPinned = () => createRecentlyUsedDefinitionClipboardPinnedInstance();

‎gnome-extensions/extension/features/RecentlyUsed/definitions/recentlyUsedOrder.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
export function getRecentlyUsedOrder(_) {
88
return [
99
{
10-
id: 'pinned',
11-
modulePath: '../definitions/recentlyUsedDefinitionPinned.js',
12-
exportName: 'RecentlyUsedDefinitionPinned',
10+
id: 'clipboard-pinned',
11+
modulePath: '../definitions/recentlyUsedDefinitionClipboardPinned.js',
12+
exportName: 'RecentlyUsedDefinitionClipboardPinned',
1313
layoutFamily: 'list',
1414
title: _('Pinned Clipboard'),
1515
titlePolicy: {
@@ -67,9 +67,9 @@ export function getRecentlyUsedOrder(_) {
6767
},
6868
},
6969
{
70-
id: 'clipboard',
71-
modulePath: '../definitions/recentlyUsedDefinitionClipboard.js',
72-
exportName: 'RecentlyUsedDefinitionClipboard',
70+
id: 'clipboard-history',
71+
modulePath: '../definitions/recentlyUsedDefinitionClipboardHistory.js',
72+
exportName: 'RecentlyUsedDefinitionClipboardHistory',
7373
layoutFamily: 'list',
7474
title: _('Recent Clipboard History'),
7575
titlePolicy: {

0 commit comments

Comments
 (0)