qulogic/libgnt

Merged in release-2.x.y (pull request #67)
release-2.x.y
2019-05-13, Gary Kramlich
bacf9b9fff30
Parents 28489e02029d45539243691c
Children ee2ed7d0e3320f64fb690a2d
Merged in release-2.x.y (pull request #67)

Replace ChangeLog.API by 'Since' API pages

Approved-by: Gary Kramlich
13 files changed, 82 insertions(+), 282 deletions(-)
  • +0 -256
    ChangeLog.API
  • +15 -3
    doc/libgnt-docs.xml
  • +6 -0
    gntbindable.h
  • +5 -0
    gntentry.c
  • +3 -2
    gntfilesel.c
  • +16 -0
    gntprogressbar.h
  • +2 -0
    gntslider.h
  • +6 -1
    gnttextview.h
  • +5 -5
    gnttree.h
  • +15 -15
    gntwidget.h
  • +5 -0
    gntwm.c
  • +2 -0
    gntwm.h
  • +2 -0
    gntws.h
    • --- a/ChangeLog.API Sat May 11 01:07:50 2019 -0400
    +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
    @@ -1,256 +0,0 @@
    -GNT: The GLib Ncurses Toolkit
    -=============================
    -
    -Please see notes about versioning in README.md.
    -
    -This file intends to list all changes to libgnt's public API. We sometimes
    -forget to add changes to this file--sorry.
    -
    -If your plugin fails to build with a new major version (e.g. 3.0.0) we suggest
    -checking this list first, in case a function was simply renamed.
    -You may still need to consult our API docs or our source code.
    -
    -If you notice something missing from this list, please let us know and we'll
    -add it.
    -
    -version 2.14.0 (????/??/??):
    - ...
    -
    -version 2.13.0 (2018/03/08):
    - No changes.
    -
    -version 2.12.0 (2017/03/09):
    - No changes.
    -
    -version 2.11.0 (2016/06/21):
    - No changes.
    -
    -version 2.10.12 (2015/12/31):
    - No changes.
    -
    -version 2.10.11 (2014/11/23):
    - No changes.
    -
    -version 2.10.10 (2014/10/22):
    - No changes.
    -
    -version 2.10.9 (2014/02/02):
    - No changes.
    -
    -version 2.10.8 (2014/01/28):
    - No changes.
    -
    -version 2.10.7 (2013/02/13):
    - No changes.
    -
    -version 2.10.6 (2012/07/06):
    - No changes.
    -
    -version 2.10.5 (2012/07/05):
    - No changes.
    -
    -version 2.10.4 (2012/05/06):
    - No changes.
    -
    -version 2.10.3 (2012/03/26):
    - No changes.
    -
    -version 2.10.2 (2012/03/14):
    - No changes.
    -
    -version 2.10.1 (2011/12/06):
    - No changes.
    -
    -version 2.10.0 (2011/08/18):
    - No changes.
    -
    -version 2.9.0 (2011/06/23):
    - No changes.
    -
    -version 2.8.0 (2011/06/07):
    - No changes.
    -
    -version 2.7.11 (2011/03/10):
    - No changes.
    -
    -version 2.7.10 (2011/02/06):
    - No changes.
    -
    -version 2.7.9 (2010/12/26):
    - No changes.
    -
    -version 2.7.8 (2010/12/19):
    - No changes.
    -
    -version 2.7.7 (2010/11/23):
    - No changes.
    -
    -version 2.7.6 (2010/11/21):
    - No changes.
    -
    -version 2.7.5 (2010/10/31):
    - No changes.
    -
    -version 2.7.4 (2010/10/20):
    - No changes.
    -
    -version 2.7.3 (2010/08/10):
    - Added:
    - * gnt_tree_row_get_child
    - * gnt_tree_row_get_key
    - * gnt_tree_row_get_next
    - * gnt_tree_row_get_parent
    - * gnt_tree_row_get_prev
    -
    -version 2.7.2 (2010/07/21):
    - No changes.
    -
    -version 2.7.1 (2010/05/29):
    - No changes.
    -
    -version 2.7.0 (2010/05/12):
    - Added:
    - * GntEntrySearch *search; member to GntEntry
    -
    -version 2.6.6 (2010/02/18):
    - No changes.
    -
    -version 2.6.5 (2010/01/08):
    - No changes.
    -
    -version 2.6.4 (2009/11/29):
    - No changes.
    -
    -version 2.6.3 (2009/10/16):
    - No changes.
    -
    -version 2.6.2 (2009/09/05):
    - No changes.
    -
    -version 2.6.1 (2009/08/18):
    - No changes.
    -
    -version 2.6.0 (2009/08/18):
    - Added:
    - * GntProgressBar and functions (Saleem Abdulrasool)
    -
    -version 2.5.9 (2009/08/18):
    - No changes.
    -
    -version 2.5.8 (2009/06/27):
    - No changes.
    -
    -version 2.5.7 (2009/06/20):
    - No changes.
    -
    -version 2.5.6 (2009/05/19):
    - No changes.
    -
    -version 2.5.5 (2009/03/01):
    - No changes.
    -
    -version 2.5.4 (2009/01/12):
    - No changes.
    -
    -version 2.5.3 (2008/12/20):
    - No changes.
    -
    -version 2.5.2 (2008/10/19):
    - No changes.
    -
    -version 2.5.1 (2008/08/30):
    - No changes.
    -
    -version 2.5.0 (2008/08/18):
    - No changes.
    -
    -version 2.4.2 (2008/05/17):
    - Added:
    - * gnt_bindable_check_key to check if a keystroke is bound.
    -
    -version 2.4.1 (2008/03/31):
    - No changes.
    -
    -version 2.4.0 (2008/02/29):
    - Added:
    - * gnt_tree_set_row_color to set the color for a row in a tree.
    - * gnt_style_get_string_list
    - * gnt_color_add_pair to define a new color.
    - * gnt_colors_get_color to get an ncurses color value from a string.
    - * gnt_style_get_color to get a color pair from an entry in ~/.gntrc
    - * gnt_tree_get_parent_key to get the key for the parent row.
    -
    -version 2.3.0 (2007/11/24):
    - Added:
    - * gnt_color_pair, which will try to intelligenty set text attributes
    - in place of colors if the terminal doesn't have color support. (Bug:
    - #3560) All future code should use gnt_color_pair instead of
    - COLOR_PAIR.
    - * gnt_menuitem_set_id and gnt_menuitem_get_id to set and get the
    - string id of a menuitem respectively.
    - * gnt_window_get_accel_item, which returns a the id of a menuitem
    - bound to a keystroke.
    - * gnt_menu_get_item to get a menuitem of the given id from a menu.
    - * gnt_menuitem_activate, which triggers the 'activate' signal on the
    - menuitem and calls the callback function, if available.
    - * GntEntryKillRing in GntEntry.
    - * gnt_window_set_maximize and gnt_window_get_maximize, and
    - GntWindowFlags enum.
    -
    -version 2.2.2 (2007/10/23):
    - No changes.
    -
    -version 2.2.1 (2007/09/29):
    - No changes.
    -
    -version 2.2.0 (2007/09/13):
    - Added:
    - * gnt_slider_set_small_step, gnt_slider_set_large_step to allow more
    - fine tuned updates of a GntSlider
    - * gnt_util_parse_xhtml_to_textview to parse XHTML strings in a
    - GntTextView (this works only if libxml2 is available)
    -
    -version 2.1.1 (2007/08/20):
    - Added:
    - * gnt_bindable_bindings_view
    - * gnt_bindable_build_help_window
    - * GNT_TEXT_VIEW_TOP_ALIGN
    -
    -version 2.1.0 (2007/07/28):
    - Added:
    - * GntWS for workspaces
    - * gnt_tree_set_column_title
    - * GntSlider widget
    - * "completion" signal for GntEntry
    - * "terminal-refresh" signal for GntWM, with a corresponding entry in
    - GntWMClass
    - * New flags for GntTextView to decide whether to word-wrap or show
    - scrollbars (GntTextViewFlag) which can be set by
    - gnt_text_view_set_flag
    - * gnt_style_get_from_name
    - * gnt_window_present
    - * gnt_tree_set_column_width_ratio
    - * gnt_tree_set_column_resizable
    - * gnt_tree_set_column_is_right_aligned
    - * gnt_tree_set_search_function
    - * gnt_tree_set_search_column
    - * gnt_tree_is_searching
    - * 'file-selected' signal is emitted for GntFileSel
    - * gnt_style_parse_bool
    - * gnt_util_set_trigger_widget
    -
    - Changed:
    - * gnt_tree_get_rows() now returns a GList* instead of a const GList*,
    - as const is not very useful with GLists. The returned value still
    - must not be modified or freed.
    - * Instead of keeping an 'invisible' item, the GntTreeColumns now
    - maintain 'flags' with the appropriate flags set
    -
    -version 2.0.2 (2007/06/14):
    - No changes.
    -
    -version 2.0.1 (2007/05/24):
    - No changes.
    -
    -version 2.0.0 (2007/05/03):
    - Initial release.
    --- a/doc/libgnt-docs.xml Sat May 11 01:07:50 2019 -0400
    +++ b/doc/libgnt-docs.xml Mon May 13 16:01:04 2019 +0000
    @@ -101,9 +101,17 @@
    <title>Index of new symbols in 2.8.0</title>
    <xi:include href="xml/api-index-2.8.0.xml"><xi:fallback /></xi:include>
    </index>
    - <index id="api-2.7.2">
    - <title>Index of new symbols in 2.7.2</title>
    - <xi:include href="xml/api-index-2.7.2.xml"><xi:fallback /></xi:include>
    + <index id="api-2.7.3">
    + <title>Index of new symbols in 2.7.3</title>
    + <xi:include href="xml/api-index-2.7.3.xml"><xi:fallback /></xi:include>
    + </index>
    + <index id="api-2.6.0">
    + <title>Index of new symbols in 2.6.0</title>
    + <xi:include href="xml/api-index-2.6.0.xml"><xi:fallback /></xi:include>
    + </index>
    + <index id="api-2.4.2">
    + <title>Index of new symbols in 2.4.2</title>
    + <xi:include href="xml/api-index-2.4.2.xml"><xi:fallback /></xi:include>
    </index>
    <index id="api-2.4.0">
    <title>Index of new symbols in 2.4.0</title>
    @@ -117,6 +125,10 @@
    <title>Index of new symbols in 2.2.0</title>
    <xi:include href="xml/api-index-2.2.0.xml"><xi:fallback /></xi:include>
    </index>
    + <index id="api-2.1.1">
    + <title>Index of new symbols in 2.1.1</title>
    + <xi:include href="xml/api-index-2.1.1.xml"><xi:fallback /></xi:include>
    + </index>
    <index id="api-2.1.0">
    <title>Index of new symbols in 2.1.0</title>
    <xi:include href="xml/api-index-2.1.0.xml"><xi:fallback /></xi:include>
    --- a/gntbindable.h Sat May 11 01:07:50 2019 -0400
    +++ b/gntbindable.h Mon May 13 16:01:04 2019 +0000
    @@ -159,6 +159,8 @@
    * Discover if a key is bound.
    *
    * Returns: %TRUE if the the key has an action associated with it.
    + *
    + * Since: 2.4.2
    */
    gboolean gnt_bindable_check_key(GntBindable *bindable, const char *keys);
    @@ -180,6 +182,8 @@
    * Returns a GntTree populated with "key" -> "binding" for the widget.
    *
    * Returns: (transfer full): The GntTree.
    + *
    + * Since: 2.1.1
    */
    GntBindable * gnt_bindable_bindings_view(GntBindable *bind);
    @@ -191,6 +195,8 @@
    * From this window a user can select a listing to rebind a new key for the given action.
    *
    * Returns: %TRUE
    + *
    + * Since: 2.1.1
    */
    gboolean gnt_bindable_build_help_window(GntBindable *bindable);
    --- a/gntentry.c Sat May 11 01:07:50 2019 -0400
    +++ b/gntentry.c Mon May 13 16:01:04 2019 +0000
    @@ -956,6 +956,11 @@
    g_cclosure_marshal_VOID__VOID,
    G_TYPE_NONE, 0);
    + /**
    + * GntEntry::completion:
    + *
    + * Since: 2.1.0
    + */
    signals[SIG_COMPLETION] =
    g_signal_new("completion",
    G_TYPE_FROM_CLASS(klass),
    --- a/gntfilesel.c Sat May 11 01:07:50 2019 -0400
    +++ b/gntfilesel.c Mon May 13 16:01:04 2019 +0000
    @@ -502,7 +502,7 @@
    kl->size_request = gnt_file_sel_size_request;
    /**
    - * GntFileSel::file-selected
    + * GntFileSel::file-selected:
    * @widget: The file selection window that received the signal
    * @path: The full path to the selected file
    * @file: The name of the file only
    @@ -510,6 +510,7 @@
    * The ::file-selected signal is emitted when the Select button or the
    * file tree on a #GntFileSel is activated.
    *
    + * Since: 2.1.0
    */
    signals[SIG_FILE_SELECTED] =
    g_signal_new("file_selected",
    @@ -521,7 +522,7 @@
    G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_STRING);
    /**
    - * GntFileSel::cancelled
    + * GntFileSel::cancelled:
    * @widget: The file selection window that received the signal
    *
    * The ::cancelled signal is emitted when the Cancel button on a
    --- a/gntprogressbar.h Sat May 11 01:07:50 2019 -0400
    +++ b/gntprogressbar.h Mon May 13 16:01:04 2019 +0000
    @@ -68,6 +68,8 @@
    * Get the #GType for GntProgressBar
    *
    * Returns: The GType for GntProrgressBar
    + *
    + * Since: 2.6.0
    */
    GType
    gnt_progress_bar_get_type (void);
    @@ -78,6 +80,8 @@
    * Create a new GntProgressBar
    *
    * Returns: The new GntProgressBar
    + *
    + * Since: 2.6.0
    */
    GntWidget *
    gnt_progress_bar_new (void);
    @@ -88,6 +92,8 @@
    * @fraction: The value between 0 and 1 to display
    *
    * Set the progress for a progress bar
    + *
    + * Since: 2.6.0
    */
    void
    gnt_progress_bar_set_fraction (GntProgressBar *pbar, gdouble fraction);
    @@ -98,6 +104,8 @@
    * @orientation: The orientation to use
    *
    * Set the orientation for a progress bar
    + *
    + * Since: 2.6.0
    */
    void
    gnt_progress_bar_set_orientation (GntProgressBar *pbar, GntProgressBarOrientation orientation);
    @@ -108,6 +116,8 @@
    * @show: A boolean indicating if the value is shown
    *
    * Controls whether the progress value is shown
    + *
    + * Since: 2.6.0
    */
    void
    gnt_progress_bar_set_show_progress (GntProgressBar *pbar, gboolean show);
    @@ -119,6 +129,8 @@
    * Get the progress that is displayed
    *
    * Returns: The progress displayed as a value between 0 and 1
    + *
    + * Since: 2.6.0
    */
    gdouble
    gnt_progress_bar_get_fraction (GntProgressBar *pbar);
    @@ -130,6 +142,8 @@
    * Get the orientation for the progress bar
    *
    * Returns: The current orientation of the progress bar
    + *
    + * Since: 2.6.0
    */
    GntProgressBarOrientation
    gnt_progress_bar_get_orientation (GntProgressBar *pbar);
    @@ -141,6 +155,8 @@
    * Get a boolean describing if the progress value is shown
    *
    * Returns: %TRUE if the progress value is shown, %FALSE otherwise.
    + *
    + * Since: 2.6.0
    */
    gboolean
    gnt_progress_bar_get_show_progress (GntProgressBar *pbar);
    --- a/gntslider.h Sat May 11 01:07:50 2019 -0400
    +++ b/gntslider.h Mon May 13 16:01:04 2019 +0000
    @@ -52,6 +52,8 @@
    * GntSlider:
    *
    * Access to any fields is deprecated. See inline comments for replacements.
    + *
    + * Since: 2.1.0
    */
    struct _GntSlider
    {
    --- a/gnttextview.h Sat May 11 01:07:50 2019 -0400
    +++ b/gnttextview.h Mon May 13 16:01:04 2019 +0000
    @@ -49,11 +49,16 @@
    typedef struct _GntTextViewPriv GntTextViewPriv;
    typedef struct _GntTextViewClass GntTextViewClass;
    +/**
    + * GntTextViewFlag:
    + *
    + * Since: 2.1.0
    + */
    typedef enum
    {
    GNT_TEXT_VIEW_NO_SCROLL = 1 << 0,
    GNT_TEXT_VIEW_WRAP_CHAR = 1 << 1,
    - GNT_TEXT_VIEW_TOP_ALIGN = 1 << 2,
    + GNT_TEXT_VIEW_TOP_ALIGN = 1 << 2, /* Since: 2.1.1 */
    } GntTextViewFlag;
    /**
    --- a/gnttree.h Sat May 11 01:07:50 2019 -0400
    +++ b/gnttree.h Mon May 13 16:01:04 2019 +0000
    @@ -251,7 +251,7 @@
    *
    * Returns: (transfer none): The key of the row.
    *
    - * Since: 2.7.2
    + * Since: 2.7.3
    */
    gpointer gnt_tree_row_get_key(GntTree *tree, GntTreeRow *row);
    @@ -264,7 +264,7 @@
    *
    * Returns: The next row.
    *
    - * Since: 2.7.2
    + * Since: 2.7.3
    */
    GntTreeRow * gnt_tree_row_get_next(GntTree *tree, GntTreeRow *row);
    @@ -277,7 +277,7 @@
    *
    * Returns: The previous row.
    *
    - * Since: 2.7.2
    + * Since: 2.7.3
    */
    GntTreeRow * gnt_tree_row_get_prev(GntTree *tree, GntTreeRow *row);
    @@ -290,7 +290,7 @@
    *
    * Returns: The child row.
    *
    - * Since: 2.7.2
    + * Since: 2.7.3
    */
    GntTreeRow * gnt_tree_row_get_child(GntTree *tree, GntTreeRow *row);
    @@ -303,7 +303,7 @@
    *
    * Returns: The parent row.
    *
    - * Since: 2.7.2
    + * Since: 2.7.3
    */
    GntTreeRow * gnt_tree_row_get_parent(GntTree *tree, GntTreeRow *row);
    --- a/gntwidget.h Sat May 11 01:07:50 2019 -0400
    +++ b/gntwidget.h Mon May 13 16:01:04 2019 +0000
    @@ -488,7 +488,7 @@
    gboolean gnt_widget_has_shadow(GntWidget *widget);
    /**
    - * gnt_widget_in_destruction
    + * gnt_widget_in_destruction:
    * @widget: The widget
    *
    * Returns whether the widget is currently being destroyed.
    @@ -502,7 +502,7 @@
    gboolean gnt_widget_in_destruction(GntWidget *widget);
    /**
    - * gnt_widget_set_drawing
    + * gnt_widget_set_drawing:
    * @widget: The widget
    * @drawing: Whether or not the widget is being drawn
    *
    @@ -513,7 +513,7 @@
    void gnt_widget_set_drawing(GntWidget *widget, gboolean drawing);
    /**
    - * gnt_widget_get_drawing
    + * gnt_widget_get_drawing:
    * @widget: The widget
    *
    * Returns whether the widget is currently being drawn.
    @@ -527,7 +527,7 @@
    gboolean gnt_widget_get_drawing(GntWidget *widget);
    /**
    - * gnt_widget_set_mapped
    + * gnt_widget_set_mapped:
    * @widget: The widget
    * @mapped: Whether or not the widget is mapped
    *
    @@ -541,7 +541,7 @@
    void gnt_widget_set_mapped(GntWidget *widget, gboolean mapped);
    /**
    - * gnt_widget_get_mapped
    + * gnt_widget_get_mapped:
    * @widget: The widget
    *
    * Whether widget is mapped or not.
    @@ -553,7 +553,7 @@
    gboolean gnt_widget_get_mapped(GntWidget *widget);
    /**
    - * gnt_widget_set_has_border
    + * gnt_widget_set_has_border:
    * @widget: The widget
    * @has_border: Whether or not the widget has a border
    *
    @@ -564,7 +564,7 @@
    void gnt_widget_set_has_border(GntWidget *widget, gboolean has_border);
    /**
    - * gnt_widget_get_has_border
    + * gnt_widget_get_has_border:
    * @widget: The widget
    *
    * Returns the has-border property on widget.
    @@ -576,7 +576,7 @@
    gboolean gnt_widget_get_has_border(GntWidget *widget);
    /**
    - * gnt_widget_set_has_shadow
    + * gnt_widget_set_has_shadow:
    * @widget: The widget
    * @has_shadow: Whether or not the widget has a shadow
    *
    @@ -589,7 +589,7 @@
    void gnt_widget_set_has_shadow(GntWidget *widget, gboolean has_shadow);
    /**
    - * gnt_widget_get_has_shadow
    + * gnt_widget_get_has_shadow:
    * @widget: The widget
    *
    * Returns the has-shadow property on widget. Note, this is a property of the
    @@ -604,7 +604,7 @@
    gboolean gnt_widget_get_has_shadow(GntWidget *widget);
    /**
    - * gnt_widget_set_has_focus
    + * gnt_widget_set_has_focus:
    * @widget: The widget
    * @has_focus: Whether or not the widget has focus
    *
    @@ -643,7 +643,7 @@
    void gnt_widget_set_is_urgent(GntWidget *widget, gboolean urgent);
    /**
    - * gnt_widget_get_urgent
    + * gnt_widget_get_urgent:
    * @widget: The widget
    *
    * Returns whether the widget has the URGENT hint set.
    @@ -666,7 +666,7 @@
    void gnt_widget_set_grow_x(GntWidget *widget, gboolean grow_x);
    /**
    - * gnt_widget_get_grow_x
    + * gnt_widget_get_grow_x:
    * @widget: The widget
    *
    * Returns whether the widget should grow in the x direction.
    @@ -689,7 +689,7 @@
    void gnt_widget_set_grow_y(GntWidget *widget, gboolean grow_y);
    /**
    - * gnt_widget_get_grow_y
    + * gnt_widget_get_grow_y:
    * @widget: The widget
    *
    * Returns whether the widget should grow in the y direction.
    @@ -712,7 +712,7 @@
    void gnt_widget_set_transient(GntWidget *widget, gboolean transient);
    /**
    - * gnt_widget_get_transient
    + * gnt_widget_get_transient:
    * @widget: The widget
    *
    * Returns whether the widget is transient.
    @@ -736,7 +736,7 @@
    gboolean disable_actions);
    /**
    - * gnt_widget_get_disable_actions
    + * gnt_widget_get_disable_actions:
    * @widget: The widget
    *
    * Returns whether the widget actions are disabled.
    --- a/gntwm.c Sat May 11 01:07:50 2019 -0400
    +++ b/gntwm.c Mon May 13 16:01:04 2019 +0000
    @@ -1508,6 +1508,11 @@
    gnt_closure_marshal_BOOLEAN__INT_INT_INT_POINTER,
    G_TYPE_BOOLEAN, 4, G_TYPE_INT, G_TYPE_INT, G_TYPE_INT, G_TYPE_POINTER);
    + /**
    + * GntWM::terminal-refresh:
    + *
    + * Since: 2.1.0
    + */
    signals[SIG_TERMINAL_REFRESH] =
    g_signal_new("terminal-refresh",
    G_TYPE_FROM_CLASS(klass),
    --- a/gntwm.h Sat May 11 01:07:50 2019 -0400
    +++ b/gntwm.h Mon May 13 16:01:04 2019 +0000
    @@ -183,6 +183,8 @@
    /* This is invoked whenever the terminal window is resized, or the
    * screen session is attached to a new terminal. (ie, from the
    * SIGWINCH callback)
    + *
    + * Since: 2.1.0
    */
    void (*terminal_refresh)(GntWM *wm);
    --- a/gntws.h Sat May 11 01:07:50 2019 -0400
    +++ b/gntws.h Mon May 13 16:01:04 2019 +0000
    @@ -46,6 +46,8 @@
    * GntWS:
    *
    * Access to any fields is deprecated. See inline comments for replacements.
    + *
    + * Since: 2.1.0
    */
    struct _GntWS
    {