/usr/include/gnucash/dialog-search.h is in gnucash-common 1:2.6.15-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | /*
* dialog-search.h -- Search Dialog
* Copyright (C) 2002 Derek Atkins
* Author: Derek Atkins <warlord@MIT.EDU>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, contact:
*
* Free Software Foundation Voice: +1-617-542-5942
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652
* Boston, MA 02110-1301, USA gnu@gnu.org
*/
#ifndef GNC_DIALOG_SEARCH_H
#define GNC_DIALOG_SEARCH_H
#include "qof.h"
typedef struct _GNCSearchWindow GNCSearchWindow;
/* The two types of callbacks.
*
* In the first callback, (used in the callback button list) the obj_p
* argument will be a pointer to the selected item (if one is
* selected). The callback may change the value if they wish (note
* that the display will not adjust to the new selected item)
*
* In the second callback, the query is the property of the search
* dialog; the callback should copy it if they want to keep it. The
* result will be a pointer to the selected item (if one is selected)
* and the callback may change the value.
*/
typedef void (*GNCSearchCallback) (gpointer *obj_p, gpointer user_data);
typedef void (*GNCSearchResultCB) (QofQuery *query, gpointer user_data,
gpointer *result);
/*
* This callback will create a new item and return a handle to the
* newly created item (even if it is not completely finished). It
* will be added to the query, but not selected. This means the GncGUID
* must be set.
*/
typedef gpointer (*GNCSearchNewItemCB) (gpointer user_data);
/* Free the general user_data object */
typedef void (*GNCSearchFree) (gpointer user_data);
/** This callback is called when (if) the user clicks the 'select'
* button. The search dialog will close when this callback function
* returns.
*/
typedef void (*GNCSearchSelectedCB) (gpointer selected_object,
gpointer user_data);
/** This callback is called when (if) the user clicks the 'select'
* button. The search dialog will close when this callback function
* returns.
*/
typedef void (*GNCSearchMultiSelectedCB) (GList *list_of_selected_objects,
gpointer user_data);
typedef struct
{
const char *label;
GNCSearchCallback cb_fcn;
GNCSearchMultiSelectedCB cb_multiselect_fn;
/** TRUE if this action should be sensitive even in a read-only book. If
FALSE, this action is sensitive in read-write book but not in a read-only
book. */
gboolean sensitive_if_readonly;
} GNCSearchCallbackButton;
/* Caller MUST supply _EITHER_ a result_callback or a list of callback
* buttons. The caller MUST NOT supply both.
*
* Both the param_list and display_list are the property of the dialog
* but will NOT be destroyed.. The param_list should be a GList of
* GNCSearchParam objects. The display_list should be a GList of
* GNCSearchParamSimple objects which defines which paramters
* of the found transactions are printed, and how.
*
* The start_query is the property of the caller and will only be copied.
* The show_start_query, if it exists, will become the property of the
* dialog and will be automatically destroyed.
*
* The user_data becomes the property of the search dialog and will
* be freed via the callback when the dialog is closed.
*
* the type_label (if non-null) is the TRANSLATED string to use for
* the type of object being searched. This will be put in the Title
* as well as into the "New" button. If this string is NULL then
* the dialog will use the obj_type instead.
*/
GNCSearchWindow *
gnc_search_dialog_create (QofIdTypeConst obj_type, const gchar *title,
GList *param_list,
GList *display_list,
QofQuery *start_query, QofQuery *show_start_query,
GNCSearchCallbackButton *callbacks,
GNCSearchResultCB result_callback,
GNCSearchNewItemCB new_item_cb,
gpointer user_data, GNCSearchFree free_user_data,
const gchar *prefs_group,
const gchar *type_label);
void gnc_search_dialog_destroy (GNCSearchWindow *sw);
void gnc_search_dialog_raise (GNCSearchWindow *sw);
/* Register an on-close signal with the Search Dialog */
guint gnc_search_dialog_connect_on_close (GNCSearchWindow *sw,
GCallback func,
gpointer user_data);
/* Un-register the signal handlers with the Search Dialog */
void gnc_search_dialog_disconnect (GNCSearchWindow *sw, gpointer user_data);
/*
* Set the select callback with this Search Window; setting it to NULL
* will effectively clear it out. If this is set, then a 'select'
* button will show up. If allow_clear is TRUE, then also allow
* a 'clear' button which would allow the selected_cb to be called
* with "NULL".
*/
void gnc_search_dialog_set_select_cb (GNCSearchWindow *sw,
GNCSearchSelectedCB selected_cb,
gpointer user_data,
gboolean allow_clear);
/* Test the dialog */
void gnc_search_dialog_test (void);
#endif /* GNC_DIALOG_SEARCH_H */
|