annotate foosdk/sdk/foobar2000/SDK/playlistColumnProvider.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #pragma once
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3 namespace fb2k {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 //! Declares a column to be made available in Default UI playlist view, \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 //! without user having to manually enter title formatting patterns.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 class playlistColumnProvider : public service_base {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(playlistColumnProvider);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 //! Number of columns published by this object.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 virtual size_t numColumns() = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 //! Unique identifier of a column.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 virtual GUID columnID(size_t col) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 //! Formatting pattern used for displaying a column.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 virtual fb2k::stringRef columnFormatSpec(size_t col) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 //! Optional; sorting pattern used for this column. Return null to use display pattern for sorting.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 virtual fb2k::stringRef columnSortScript(size_t col) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 //! Name of the column shown to the user.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 virtual fb2k::stringRef columnName(size_t col) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 //! Display flags (alignment). \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 //! See flag_* constants.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21 virtual unsigned columnFlags(size_t col) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 static constexpr unsigned
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 flag_alignLeft = 0, flag_alignRight = 1 << 0, flag_alignCenter = 1 << 1, // alignment
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 flag_numeric = 1 << 2, // prefer fixed width font, not all renderers support this
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 flag_positionDependant = 1 << 3, // value changes with position in playlist, mainly used by list index etc
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 flag_glyphs = 1 << 4; // internal/reserved
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 static constexpr unsigned flag_alignMask = (flag_alignLeft|flag_alignRight|flag_alignCenter);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 }