[17db19]: gtkextra / gtkdataentry.c Maximize Restore History

Download this file

gtkdataentry.c    667 lines (572 with data), 17.7 kB

  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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
/* gtkdataentry - data entry widget, based on GtkEntry
* Copyright 2011 Fredy Paquet <fredy@opag.ch>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <math.h>
#include <gtk/gtk.h>
#define __GTKEXTRA_H_INSIDE__
#include "gtkextra-compat.h"
#include "gtkdataentry.h"
#include "gtkdataformat.h"
/**
* SECTION: gtkdataentry
* @short_description: a data entry widget, based on GtkEntry
*
* GtkDataEntry provides additional properties:
*
* - #GtkDataEntry:description - no functionality, a place for
* private information that cannot be put anywhere else
*
* - #GtkDataEntry:datatype - no functionality, a datatype hint
* for the application because any widget content is text
*
* - #GtkDataEntry:dataformat - a formatting instruction that
* controls what you see when the widget doesn't have input
* focus
*
* - #GtkDataEntry:text - set the contents of the widget. if the
* widget doesn't have input focus text will be formatted
* according to the data_format
*
* - #GtkDataEntry:max-length-bytes - set the maximum byte
* length for the contents of the widget.
*
* The main reason for this widget is to provide a formatting
* entry widget for numeric data like integer, float, money
* which also supports NULL values (GtkSpinButton is nice but
* doesn't support empty field values). Handling of Null values
* is supported by all SQL database systems. The Null values are
* represented by empty field contents.
*
* When editing field contents, all data formatting is removed
* before the focus enters the widget. As soon as the focus
* leaves the widget, data will be nicely formatted again.
*
* As an additional feature, the minus sign (negative numbers)
* can be entered at the end of the data. As soon as you leave
* the field it will be placed properly in front of the number.
*
* See also: gtk_data_format()
*
*/
#undef GTK_DATA_ENTRY_DEBUG
#ifdef DEBUG
#define GTK_DATA_ENTRY_DEBUG 0 /* define to activate debug output */
#endif
#if GTK_DATA_ENTRY_DEBUG
#define GTK_DATA_ENTRY_DEBUG_SIGNAL 0 /* debug signal handlers */
#endif
enum
{
PROP_0,
PROP_DATA_ENTRY_DATATYPE,
PROP_DATA_ENTRY_DATAFORMAT,
PROP_DATA_ENTRY_DESCRIPTION,
PROP_DATA_ENTRY_TEXT,
PROP_DATA_ENTRY_MAX_LENGTH_BYTES,
} GTK_DATA_ENTRY_PROPERTIES;
enum
{
LAST_SIGNAL
} GTK_DATA_ENTRY_SIGNALS;
static void gtk_data_entry_class_init(GtkDataEntryClass *klass);
static void gtk_data_entry_init(GtkDataEntry *data);
static GtkEntryClass *parent_class = NULL;
/**
* gtk_data_entry_get_description:
* @data_entry: a #GtkDataEntry
*
* Retrieves the #GtkDataEntry description.
*
* Returns: a pointer to the contents of the widget as a
* string. This string points to internally allocated
* storage in the widget and must not be freed, modified or
* stored.
**/
const gchar *
gtk_data_entry_get_description(GtkDataEntry *data_entry)
{
g_return_val_if_fail(GTK_IS_DATA_ENTRY(data_entry), NULL);
return data_entry->description;
}
/**
* gtk_data_entry_set_description:
* @data_entry: a #GtkDataEntry
* @description: the description or NULL
*
* Sets the GtkDataEntry description.
*/
void gtk_data_entry_set_description(GtkDataEntry *data_entry,
const gchar *description)
{
g_return_if_fail(data_entry != NULL);
g_return_if_fail(GTK_IS_DATA_ENTRY(data_entry));
if (data_entry->description)
g_free(data_entry->description);
data_entry->description = g_strdup(description);
}
/**
* gtk_data_entry_get_data_type:
* @data_entry: a #GtkDataEntry
*
* Retrieves the #GtkDataEntry data_type.
*
* Returns: a pointer to the contents of the widget as a
* string. This string points to internally allocated
* storage in the widget and must not be freed, modified or
* stored.
**/
const gchar *
gtk_data_entry_get_data_type(GtkDataEntry *data_entry)
{
g_return_val_if_fail(GTK_IS_DATA_ENTRY(data_entry), NULL);
return data_entry->data_type;
}
/**
* gtk_data_entry_set_data_type:
* @data_entry: a #GtkDataEntry
* @data_type: the data type or NULL
*
* Sets the GtkDataEntry data type for application use.
*/
void gtk_data_entry_set_data_type(GtkDataEntry *data_entry,
const gchar *data_type)
{
g_return_if_fail(data_entry != NULL);
g_return_if_fail(GTK_IS_DATA_ENTRY(data_entry));
if (data_entry->data_type)
g_free(data_entry->data_type);
data_entry->data_type = g_strdup(data_type);
}
/**
* gtk_data_entry_get_data_format:
* @data_entry: a #GtkDataEntry
*
* Retrieves the #GtkDataEntry data_format.
*
* See gtk_data_format() for details.
*
* Returns: a pointer to the contents of the widget as a
* string. This string points to internally allocated
* storage in the widget and must not be freed, modified or
* stored.
**/
const gchar *
gtk_data_entry_get_data_format(GtkDataEntry *data_entry)
{
g_return_val_if_fail(GTK_IS_DATA_ENTRY(data_entry), NULL);
return data_entry->data_format;
}
/**
* gtk_data_entry_set_data_format:
* @data_entry: a #GtkDataEntry
* @data_format: the data type or NULL
*
* Sets the GtkDataEntry data type for application use. The
* display will not be refreshed upon change.
*
* See gtk_data_format() for details.
*
*/
void gtk_data_entry_set_data_format(GtkDataEntry *data_entry,
const gchar *data_format)
{
g_return_if_fail(data_entry != NULL);
g_return_if_fail(GTK_IS_DATA_ENTRY(data_entry));
if (data_entry->data_format)
g_free(data_entry->data_format);
data_entry->data_format = g_strdup(data_format);
}
/**
* gtk_data_entry_get_text:
* @data_entry: a #GtkDataEntry
*
* Retrieves the #GtkDataEntry contents. All formatting will be
* removed.
*
* Returns: a pointer to the contents of the widget as a
* string. This string points to internally allocated
* storage in the widget and must not be freed, modified or
* stored.
**/
const gchar *
gtk_data_entry_get_text(GtkDataEntry *data_entry)
{
gchar *text;
g_return_val_if_fail(GTK_IS_DATA_ENTRY(data_entry), NULL);
text = (gchar *)gtk_entry_get_text(GTK_ENTRY(data_entry));
if (!gtk_widget_has_focus(GTK_WIDGET(data_entry)))
{
text = gtk_data_format_remove(text, data_entry->data_format);
}
#if GTK_DATA_ENTRY_DEBUG
g_debug("gtk_data_entry_get_text: %s", text ? text : "");
#endif
return text;
}
/**
* gtk_data_entry_set_text:
* @data_entry: a #GtkDataEntry
* @text: the contents to be set
*
* Sets the GtkDataEntry contents. The contents will be
* formatted due to the current data_format.
*/
void gtk_data_entry_set_text(GtkDataEntry *data_entry,
const gchar *text)
{
g_return_if_fail(data_entry != NULL);
g_return_if_fail(GTK_IS_DATA_ENTRY(data_entry));
if (!gtk_widget_has_focus(GTK_WIDGET(data_entry)))
{
text = gtk_data_format(text, data_entry->data_format);
}
#if GTK_DATA_ENTRY_DEBUG
g_debug("gtk_data_entry_set_text: %s", text ? text : "");
#endif
gtk_entry_set_text(GTK_ENTRY(data_entry), text);
}
/**
* gtk_data_entry_get_max_length_bytes:
* @data_entry: a #GtkDataEntry
*
* Retrieves the maximum byte length for the contents of
* #GtkDataEntry.
*
* Returns: maximum byte length or 0.
*
* Since: 3.0.6
**/
gint
gtk_data_entry_get_max_length_bytes(GtkDataEntry *data_entry)
{
g_return_val_if_fail(GTK_IS_DATA_ENTRY(data_entry), 0);
return data_entry->max_length_bytes;
}
/**
* gtk_data_entry_set_max_length_bytes:
* @data_entry: a #GtkDataEntry
* @max_length_bytes: maximum byte length or 0
*
* Sets the maximum byte length for the contents of the
* #GtkDataEntry. Existing content will not be truncted.
*
* Since: 3.0.6
*/
void gtk_data_entry_set_max_length_bytes(GtkDataEntry *data_entry,
gint max_length_bytes)
{
g_return_if_fail(data_entry != NULL);
g_return_if_fail(GTK_IS_DATA_ENTRY(data_entry));
if (max_length_bytes < 0)
max_length_bytes = 0;
if (max_length_bytes > GTK_ENTRY_BUFFER_MAX_SIZE)
max_length_bytes = GTK_ENTRY_BUFFER_MAX_SIZE;
data_entry->max_length_bytes = max_length_bytes;
}
GType
gtk_data_entry_get_type(void)
{
static GType data_entry_type = 0;
if (!data_entry_type)
{
static const GInterfaceInfo interface_info = {
(GInterfaceInitFunc)NULL,
(GInterfaceFinalizeFunc)NULL,
(gpointer)NULL
};
data_entry_type = g_type_register_static_simple(
gtk_entry_get_type(),
"GtkDataEntry",
sizeof(GtkDataEntryClass),
(GClassInitFunc)gtk_data_entry_class_init,
sizeof(GtkDataEntry),
(GInstanceInitFunc)gtk_data_entry_init,
0);
g_type_add_interface_static(data_entry_type,
GTK_TYPE_BUILDABLE,
&interface_info);
}
return (data_entry_type);
}
static void
gtk_data_entry_set_property(GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkDataEntry *data_entry = GTK_DATA_ENTRY(object);
switch(prop_id)
{
case PROP_DATA_ENTRY_DATATYPE:
{
const gchar *data_type = g_value_get_string(value);
if (!gtk_widget_get_realized(GTK_WIDGET(data_entry)))
{
if (data_entry->data_type)
g_free(data_entry->data_type);
data_entry->data_type = g_strdup(data_type);
}
else
{
gtk_data_entry_set_data_type(data_entry, data_type);
}
}
break;
case PROP_DATA_ENTRY_DATAFORMAT:
{
const gchar *data_format = g_value_get_string(value);
if (!gtk_widget_get_realized(GTK_WIDGET(data_entry)))
{
if (data_entry->data_format)
g_free(data_entry->data_format);
data_entry->data_format = g_strdup(data_format);
}
else
{
gtk_data_entry_set_data_format(data_entry, data_format);
}
}
break;
case PROP_DATA_ENTRY_DESCRIPTION:
{
const gchar *description = g_value_get_string(value);
if (!gtk_widget_get_realized(GTK_WIDGET(data_entry)))
{
if (data_entry->description)
g_free(data_entry->description);
data_entry->description = g_strdup(description);
}
else
{
gtk_data_entry_set_description(data_entry, description);
}
}
break;
case PROP_DATA_ENTRY_TEXT:
gtk_data_entry_set_text(data_entry, g_value_get_string(value));
break;
case PROP_DATA_ENTRY_MAX_LENGTH_BYTES:
gtk_data_entry_set_max_length_bytes(data_entry, g_value_get_int(value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
break;
}
}
static void
gtk_data_entry_get_property(GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkDataEntry *data_entry = GTK_DATA_ENTRY(object);
switch(prop_id)
{
case PROP_DATA_ENTRY_DATATYPE:
g_value_set_string(value, data_entry->data_type);
break;
case PROP_DATA_ENTRY_DATAFORMAT:
g_value_set_string(value, data_entry->data_format);
break;
case PROP_DATA_ENTRY_DESCRIPTION:
g_value_set_string(value, data_entry->description);
break;
case PROP_DATA_ENTRY_TEXT:
g_value_set_string(value, gtk_data_entry_get_text(data_entry));
break;
case PROP_DATA_ENTRY_MAX_LENGTH_BYTES:
g_value_set_int(value, gtk_data_entry_get_max_length_bytes(data_entry));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
break;
}
}
static gint
gtk_data_entry_focus_in(GtkWidget *widget, GdkEventFocus *event)
{
const gchar *text = gtk_entry_get_text(GTK_ENTRY(widget));
gchar *data_format = GTK_DATA_ENTRY(widget)->data_format;
#if GTK_DATA_ENTRY_DEBUG
g_debug("gtk_data_entry_focus_in: called");
#endif
if (data_format && data_format[0])
{
text = gtk_data_format_remove(text, data_format);
gtk_entry_set_text(GTK_ENTRY(widget), text);
}
return ((*GTK_WIDGET_CLASS(parent_class)->focus_in_event)(widget, event));
}
static gint
gtk_data_entry_focus_out(GtkWidget *widget, GdkEventFocus *event)
{
const gchar *text = gtk_entry_get_text(GTK_ENTRY(widget));
gchar *data_format = GTK_DATA_ENTRY(widget)->data_format;
#if GTK_DATA_ENTRY_DEBUG
g_debug("gtk_data_entry_focus_out: called");
#endif
if (data_format && data_format[0])
{
text = gtk_data_format(text, data_format);
gtk_entry_set_text(GTK_ENTRY(widget), text);
}
return ((*GTK_WIDGET_CLASS(parent_class)->focus_out_event)(widget, event));
}
static void
gtk_data_entry_class_init(GtkDataEntryClass *klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
#if 0
GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
GtkEntryClass *entry_class = GTK_ENTRY_CLASS (klass);
#endif
parent_class = g_type_class_ref(gtk_entry_get_type());
gobject_class->set_property = gtk_data_entry_set_property;
gobject_class->get_property = gtk_data_entry_get_property;
widget_class->focus_in_event = gtk_data_entry_focus_in;
widget_class->focus_out_event = gtk_data_entry_focus_out;
/**
* GtkDataEntry:datatype:
*
* no functionality, a datatype hint for the application because
* any widget content is text.
*/
g_object_class_install_property(gobject_class,
PROP_DATA_ENTRY_DATATYPE,
g_param_spec_string("datatype",
"Datatype",
"Data type for application use",
"" /* default value */,
G_PARAM_READWRITE));
/**
* GtkDataEntry:dataformat:
*
* a formatting string that controls what you see when the
* widget doesn't contain input focus.
*
* See gtk_data_format() for details.
*
*/
g_object_class_install_property(gobject_class,
PROP_DATA_ENTRY_DATAFORMAT,
g_param_spec_string("dataformat",
"Data format",
"A formatting string that controls what you see when the widget doesn't contain input focus",
"" /* default value */,
G_PARAM_READWRITE));
/**
* GtkDataEntry:description:
*
* Description of the GtkDataEntry, no functionality, a place
* for private information that cannot be put anywhere else.
*/
g_object_class_install_property(gobject_class,
PROP_DATA_ENTRY_DESCRIPTION,
g_param_spec_string("description",
"Description",
"Description of entry contents",
"" /* default value */,
G_PARAM_READWRITE));
/**
* GtkDataEntry:text:
*
* Set the contents of the GtkDataEntry. For details see
* #gtk_data_entry_set_text.
*/
g_object_class_install_property(gobject_class,
PROP_DATA_ENTRY_TEXT,
g_param_spec_string("text",
"Text",
"The contents of the data_entry",
"" /* default value */,
G_PARAM_READWRITE));
/**
* GtkDataEntry:max-length-bytes:
*
* Set the maximum length in bytes for the GtkDataEntry. For
* details see #gtk_data_entry_set_max_length_bytes.
*
* Sometimes, systems cannot handle UTF-8 string length
* correctly, to overcome this problem, you can use the maximum
* string length in bytes. When setting both limits, max-length
* and max-length-bytes, both must be fulfilled.
*
* Since: 3.0.6
*/
g_object_class_install_property(gobject_class,
PROP_DATA_ENTRY_MAX_LENGTH_BYTES,
g_param_spec_int("max-length-bytes",
"Maximum bytes length",
"The maximum number of bytes for this entry. Zero if no maximum",
0, GTK_ENTRY_BUFFER_MAX_SIZE,
0 /* default value */,
G_PARAM_READWRITE));
}
/* Signal interception */
static void _gtk_data_entry_insert_text_handler(GtkEditable *editable,
gchar *new_text, gint new_text_length,
gpointer position, gpointer user_data)
{
GtkDataEntry *data_entry = GTK_DATA_ENTRY(editable);
gint max_len = data_entry->max_length_bytes;
if (!max_len) return;
const gchar *old_text = gtk_data_entry_get_text(data_entry);
gint old_length = strlen(old_text);
if (new_text_length < 0) new_text_length = strlen(new_text);
#if GTK_DATA_ENTRY_DEBUG_SIGNAL > 0
g_debug("_gtk_data_entry_insert_text_handler(bytes): cl %d max %d new %d",
old_length, max_len, new_text_length);
#endif
if (old_length + new_text_length > max_len)
{
gdk_beep();
g_signal_stop_emission_by_name(editable, "insert-text");
}
}
static void
gtk_data_entry_init(GtkDataEntry *data_entry)
{
#if 0
GtkWidget *widget = GTK_WIDGET(data_entry);
#endif
data_entry->description = NULL;
data_entry->data_type = NULL;
data_entry->data_format = NULL;
data_entry->max_length_bytes = 0;
g_debug("gtk_data_entry_init");
g_signal_connect(GTK_BUILDABLE(data_entry), "insert-text",
G_CALLBACK(_gtk_data_entry_insert_text_handler), NULL);
}
/**
* gtk_data_entry_new:
*
* Creates a new GtkDataEntry Widget.
*
* Returns: the new GtkDataEntry Widget
*/
GtkDataEntry *
gtk_data_entry_new(void)
{
GtkDataEntry *data_entry = GTK_DATA_ENTRY(
gtk_widget_new(gtk_data_entry_get_type(), NULL));
return (data_entry);
}