|
NCBI Home IEB Home C Toolkit docs C++ Toolkit source browser C Toolkit source browser (2) |
NCBI C Toolkit Cross ReferenceC/desktop/entrez2.h |
source navigation diff markup identifier search freetext search file search |
1 /* entrez2.h
2 * ===========================================================================
3 *
4 * PUBLIC DOMAIN NOTICE
5 * National Center for Biotechnology Information (NCBI)
6 *
7 * This software/database is a "United States Government Work" under the
8 * terms of the United States Copyright Act. It was written as part of
9 * the author's official duties as a United States Government employee and
10 * thus cannot be copyrighted. This software/database is freely available
11 * to the public for use. The National Library of Medicine and the U.S.
12 * Government do not place any restriction on its use or reproduction.
13 * We would, however, appreciate having the NCBI and the author cited in
14 * any work or product based on this material
15 *
16 * Although all reasonable efforts have been taken to ensure the accuracy
17 * and reliability of the software and data, the NLM and the U.S.
18 * Government do not and cannot warrant the performance or results that
19 * may be obtained by using this software or data. The NLM and the U.S.
20 * Government disclaim all warranties, express or implied, including
21 * warranties of performance, merchantability or fitness for any particular
22 * purpose.
23 *
24 * ===========================================================================
25 *
26 * File Name: entrez2.h
27 *
28 * Author: Jonathan Kans, Greg Schuler, Jonathan Epstein, Tim Ford
29 *
30 * Version Creation Date: 10/30/01
31 *
32 * $Revision: 6.5 $
33 *
34 * File Description:
35 *
36 * Modifications:
37 * --------------------------------------------------------------------------
38 *
39 * ==========================================================================
40 */
41
42 #ifndef _ENTREZ2_
43 #define _ENTREZ2_
44
45 #include <vibrant.h>
46 #include <ent2api.h>
47
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52 /*
53 * The following callback types help process requests between forms. The
54 * form passed in belongs to the calling form, not the target form. It is
55 * up to the application to pass the request to the appropriate form. This
56 * way, there can be multiple term list and docsum forms, and the window
57 * handles are not global to the libraries.
58 */
59
60 typedef void (*E2RetrieveDocsProc) (ButtoN buttonPressed);
61 typedef void (*E2RetrieveUidProc) (ForM queryForm, Int4 uid, CharPtr dbName);
62 typedef void (*E2ProjectToFormProc) (ForM f, Pointer proj);
63 typedef void (*E2SimpleSeqProc) (ForM f, ValNodePtr simpleSeqs);
64 typedef void (*E2NamedUidListProc) (ForM f, CharPtr term, Int4 num, Int4Ptr uids, Int2 db);
65 typedef void (*E2LaunchViewerProc) (ForM f, Int4 uid, Int2 numAlign, Int4Ptr alignuids, Int2 db, Int2 launchType);
66
67 /*
68 * The Entrez2GlobalsPtr may be registered with a call to SetAppProperty
69 * e.g., SetAppProperty ("Entrez2Globals", &entrezglobals), where entrezglobals
70 * is a persistent structure filled with Vibrant objects or callback
71 * function pointers specific for a given application.
72 */
73
74 typedef struct entrez2globals {
75 IteM parentsPersist;
76 IteM alignWithChecked;
77 ChoicE seqComplex;
78 ChoicE strucComplex;
79 ChoicE strucModels;
80 FonT docsumFont;
81
82 Boolean persistDefault;
83 Boolean alignDefault;
84 Boolean popdownBehavior;
85 Boolean lookupDirect;
86 Boolean showAsn;
87 Boolean sortFields;
88 CharPtr initDatabase;
89 CharPtr initField;
90 CharPtr initMode;
91
92 WndActnProc createTrmLstMenus;
93 WndActnProc createDocSumMenus;
94
95 E2RetrieveDocsProc retrieveDocsProc;
96 E2RetrieveUidProc retrieveUidProc;
97 E2ProjectToFormProc retrieveProjectProc;
98 E2SimpleSeqProc retrieveSimpleProc;
99 E2NamedUidListProc loadNamedUidProc;
100 E2LaunchViewerProc launchViewerProc;
101 } Entrez2Globals, PNTR Entrez2GlobalsPtr;
102
103 NLM_EXTERN ForM CreateTermlistForm (
104 Int2 left,
105 Int2 top,
106 CharPtr title,
107 WndActnProc activateCallback,
108 FormMessageFunc messagesCallback,
109 E2RetrieveDocsProc retrieveCallback,
110 E2RetrieveUidProc retrieveUidCallback,
111 Boolean explodeToggle,
112 Boolean advancedQueryToggle
113 );
114
115 NLM_EXTERN ForM CreateDocsumForm (
116 Int2 left,
117 Int2 top,
118 CharPtr title,
119 WndActnProc activate,
120 FormMessageFunc messages,
121 E2NamedUidListProc refineUidCallback,
122 Boolean delayedNeighbor
123 );
124
125 NLM_EXTERN void ShowNewNetConfigForm (
126 WndActnProc activate,
127 FormMessageFunc messages,
128 VoidProc accepted,
129 VoidProc cancelled,
130 VoidProc turnedOff,
131 Boolean netCurrentlyOn
132 );
133
134 NLM_EXTERN void RetrieveDocs (ForM f, Int2 num, Int2 parents, Int4Ptr uids, CharPtr dbName);
135 NLM_EXTERN void LaunchRecViewer (ForM f, Int4 uid, Int2 numAlign, Int4Ptr alignuids, Int2 db, Int2 launchType);
136
137 NLM_EXTERN Boolean RefineUIDs (ForM f, CharPtr term, Int4 num, Int4Ptr uids, Int2 db);
138
139 NLM_EXTERN Boolean ShowASN (void);
140 NLM_EXTERN void DisplayEntrezReply (Entrez2ReplyPtr e2ry);
141 NLM_EXTERN void DisplayEntrezRequest (Entrez2RequestPtr e2rq);
142
143 NLM_EXTERN Int2 DBGetIDFromName (CharPtr dbName);
144 NLM_EXTERN CharPtr DBGetNameFromID (Int2 dbId);
145
146 NLM_EXTERN Entrez2InfoPtr Query_GetInfo (void);
147
148 NLM_EXTERN Entrez2BooleanReplyPtr Query_FetchUIDs (ForM f);
149 NLM_EXTERN Int4 Query_FetchCount (ForM f);
150 NLM_EXTERN Int4 Query_FetchParsedCount (ForM f);
151 NLM_EXTERN Entrez2TermListPtr Query_FetchSeveralCounts (CharPtr dbName, CharPtr fieldName, CharPtr searchStr, Int2 count);
152
153 NLM_EXTERN Boolean TermList_UnselectAll (ForM f);
154
155 NLM_EXTERN EnumFieldAssocPtr CreateDatabaseAlist (Entrez2InfoPtr e2ip);
156 NLM_EXTERN EnumFieldAssocPtr CreateFieldAlist (Entrez2DbInfoPtr e2db);
157
158 #ifdef __cplusplus
159 }
160 #endif
161
162 #endif /* _ENTREZ2_ */
163
164 |
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more information. |