]>
Commit | Line | Data |
---|---|---|
c801d85f KB |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: list.h | |
3 | // Purpose: wxList, wxStringList classes | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 29/01/98 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 1998 Julian Smart | |
9 | // Licence: wxWindows license | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef __LISTH__ | |
13 | #define __LISTH__ | |
14 | ||
15 | #ifdef __GNUG__ | |
0d3820b3 | 16 | #pragma interface "list.h" |
c801d85f KB |
17 | #endif |
18 | ||
19 | #include "wx/defs.h" | |
20 | #include "wx/object.h" | |
21 | ||
22 | class WXDLLEXPORT wxList; | |
23 | ||
24 | #define wxKEY_NONE 0 | |
25 | #define wxKEY_INTEGER 1 | |
26 | #define wxKEY_STRING 2 | |
27 | class WXDLLEXPORT wxNode: public wxObject | |
28 | { | |
29 | DECLARE_DYNAMIC_CLASS(wxNode) | |
30 | private: | |
31 | ||
32 | wxObject *data; | |
33 | wxNode *next; | |
34 | wxNode *previous; | |
35 | ||
36 | public: | |
37 | wxList *list; | |
38 | ||
39 | // Optional key stuff | |
40 | union | |
41 | { | |
42 | long integer; | |
43 | char *string; | |
44 | } key; | |
45 | ||
46 | wxNode(wxList *the_list = NULL, wxNode *last_one = NULL, wxNode *next_one = NULL, wxObject *object = NULL); | |
47 | wxNode(wxList *the_list, wxNode *last_one, wxNode *next_one, | |
48 | wxObject *object, long the_key); | |
49 | wxNode(wxList *the_list, wxNode *last_one, wxNode *next_one, | |
50 | wxObject *object, const char *the_key); | |
51 | ~wxNode(void); | |
52 | ||
53 | inline wxNode *Next(void) const { return next; } | |
54 | inline wxNode *Previous(void) const { return previous; } | |
55 | inline wxObject *Data(void) const { return (wxObject *)data; } | |
56 | inline void SetData(wxObject *the_data) { data = the_data; } | |
57 | }; | |
58 | ||
59 | // type of compare function for list sort operation (as in 'qsort') | |
60 | typedef int (*wxSortCompareFunction)(const void *elem1, const void *elem2); | |
61 | typedef int (*wxListIterateFunction)(wxObject *o); | |
62 | ||
63 | class WXDLLEXPORT wxList: public wxObject | |
64 | { | |
65 | DECLARE_DYNAMIC_CLASS(wxList) | |
66 | ||
67 | public: | |
68 | int n; | |
69 | int destroy_data; | |
70 | wxNode *first_node; | |
71 | wxNode *last_node; | |
72 | unsigned int key_type; | |
73 | ||
74 | wxList(void); | |
75 | wxList(const unsigned int the_key_type); | |
debe6624 | 76 | wxList(int N, wxObject *Objects[]); |
c801d85f KB |
77 | wxList(wxObject *object, ...); |
78 | ||
c801d85f KB |
79 | ~wxList(void); |
80 | ||
81 | inline int Number(void) const { return n; } | |
82 | ||
83 | // Append to end of list | |
84 | wxNode *Append(wxObject *object); | |
85 | ||
86 | // Insert at front of list | |
87 | wxNode *Insert(wxObject *object); | |
88 | ||
89 | // Insert before given node | |
90 | wxNode *Insert(wxNode *position, wxObject *object); | |
91 | ||
92 | // Keyed append | |
debe6624 | 93 | wxNode *Append(long key, wxObject *object); |
c801d85f KB |
94 | wxNode *Append(const char *key, wxObject *object); |
95 | ||
96 | bool DeleteNode(wxNode *node); | |
97 | bool DeleteObject(wxObject *object); // Finds object pointer and | |
98 | // deletes node (and object if | |
99 | // DeleteContents is on) | |
100 | void Clear(void); // Delete all nodes | |
101 | ||
102 | inline wxNode *First(void) const { return first_node; } | |
103 | inline wxNode *Last(void) const { return last_node; } | |
debe6624 | 104 | wxNode *Nth(int i) const; // nth node counting from 0 |
c801d85f KB |
105 | |
106 | // Keyed search | |
debe6624 | 107 | wxNode *Find(long key) const; |
c801d85f KB |
108 | wxNode *Find(const char *key) const; |
109 | ||
110 | wxNode *Member(wxObject *object) const; | |
111 | ||
debe6624 | 112 | inline void DeleteContents(int destroy) { destroy_data = destroy; } |
c801d85f KB |
113 | // Instruct it to destroy user data |
114 | // when deleting nodes | |
115 | // this function allows the sorting of arbitrary lists by giving | |
116 | // a function to compare two list elements. | |
117 | void Sort(const wxSortCompareFunction compfunc); | |
118 | ||
119 | wxObject *FirstThat(wxListIterateFunction func); | |
120 | void ForEach(wxListIterateFunction func); | |
121 | wxObject *LastThat(wxListIterateFunction func); | |
122 | }; | |
123 | ||
124 | // String list class. N.B. this always copies strings | |
125 | // with Add and deletes them itself. | |
126 | class WXDLLEXPORT wxStringList: public wxList | |
127 | { | |
128 | DECLARE_DYNAMIC_CLASS(wxStringList) | |
129 | ||
130 | public: | |
131 | wxStringList(void); | |
132 | wxStringList(const char *first ...); | |
133 | ~wxStringList(void); | |
134 | ||
135 | virtual wxNode *Add(const char *s); | |
136 | virtual void Delete(const char *s); | |
debe6624 | 137 | virtual char **ListToArray(bool new_copies = FALSE) const; |
c801d85f KB |
138 | virtual void Sort(void); |
139 | virtual bool Member(const char *s) const; | |
140 | }; | |
141 | ||
142 | #endif | |
143 | // __LISTH__ |