X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fview%2Fruler.hpp;h=cf63eaff7c7cb27ae0b2ec451801bda05b23677d;hp=f717c3785674c2b814838b915a18d18741ad6fed;hb=453b6d63444bf7fb03242761653fd18e9cde7443;hpb=c677193dc6e691493081fe87476a04e1674093a5

diff --git a/pv/view/ruler.hpp b/pv/view/ruler.hpp
index f717c378..cf63eaff 100644
--- a/pv/view/ruler.hpp
+++ b/pv/view/ruler.hpp
@@ -72,6 +72,39 @@ public:
 	 */
 	QSize extended_size_hint() const;
 
+	/**
+	 * Formats a timestamp depending on its distance to another timestamp.
+	 *
+	 * Heuristic function, useful when multiple timestamps should be put side by
+	 * side. The function procedes in the following order:
+	 *   - If 't' is zero, "0" is returned.
+	 *   - If 'unit' is 'TimeUnit::Samples', 'pv::util::format_time_si_adjusted()'
+	 *     is used to format 't'.
+	 *   - If a zoomed out view is detected (determined by 'precision' and
+	 *     'distance'), 'pv::util::format_time_minutes() is used.
+	 *   - For timestamps "near the origin" (determined by 'distance'),
+	 *    'pv::util::format_time_si_adjusted()' is used.
+	 *   - If none of the previous was true, 'pv::util::format_time_minutes()'
+	 *     is used again.
+	 *
+	 * @param distance The distance between the timestamp to format and
+	 *        an adjacent one.
+	 * @param t The value to format
+	 * @param prefix The SI prefix to use.
+	 * @param unit The representation of the timestamp value.
+	 * @param precision The number of digits after the decimal separator.
+	 * @param sign Whether or not to add a sign also for positive numbers.
+	 *
+	 * @return The formated value.
+	 */
+	static QString format_time_with_distance(
+		const pv::util::Timestamp& distance,
+		const pv::util::Timestamp& t,
+		pv::util::SIPrefix prefix = pv::util::SIPrefix::unspecified,
+		pv::util::TimeUnit unit = pv::util::TimeUnit::Time,
+		unsigned precision = 0,
+		bool sign = true);
+
 private:
 	/**
 	 * Gets the time items.
@@ -87,7 +120,6 @@ private:
 	std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
 		const QPoint &pt);
 
-private:
 	void paintEvent(QPaintEvent *event);
 
 	void mouseDoubleClickEvent(QMouseEvent *e);