Document and deprecate HILDON_WINDOW_LONG_PRESS_TIME

* hildon/hildon-window.h:
Document and deprecate HILDON_WINDOW_LONG_PRESS_TIME

Fixes: MB#4580 (HILDON_WINDOW_LONG_PRESS_TIME is undocumented)

diff --git a/ChangeLog b/ChangeLog
index f1fa87e..c75ec94 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-09-04  Alberto Garcia  <agarcia@igalia.com>
+
+       * hildon/hildon-window.h:
+       Document and deprecate HILDON_WINDOW_LONG_PRESS_TIME
+
+       Fixes: MB#4580 (HILDON_WINDOW_LONG_PRESS_TIME is undocumented)
+
 2009-09-04  Claudio Saavedra  <csaavedra@igalia.com>
 
        [Release 2.1.97]

diff --git a/hildon/hildon-window.h b/hildon/hildon-window.h
index be0f03b..818f9ab 100644 (file)
--- a/hildon/hildon-window.h
+++ b/hildon/hildon-window.h
@@ -31,7 +31,18 @@
 
 G_BEGIN_DECLS
 
-#define                                         HILDON_WINDOW_LONG_PRESS_TIME 800 /* in ms */
+#ifndef HILDON_DISABLE_DEPRECATED
+/**
+ * HILDON_WINDOW_LONG_PRESS_TIME:
+ *
+ * Time (in miliseconds) after which a hardware key press is
+ * considered a long press.
+ *
+ * Deprecated: Hildon 2.2: this value is only meant to be used
+ * internally by Hildon.
+ */
+#define                                         HILDON_WINDOW_LONG_PRESS_TIME 800
+#endif
 
 #define                                         HILDON_TYPE_WINDOW \
                                                 (hildon_window_get_type())