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
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Camelot.camelot.view.elixir_admin.EntityAdmin</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package Camelot ::
<a href="Camelot.camelot-module.html">Package camelot</a> ::
<a href="Camelot.camelot.view-module.html">Package view</a> ::
<a href="Camelot.camelot.view.elixir_admin-module.html">Module elixir_admin</a> ::
Class EntityAdmin
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class EntityAdmin</h1><p class="nomargin-top"><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_camelot__220" name="uml_class_diagram_for_camelot__220">
<area shape="rect" href="javascript:void(0);" title="hash(x)" alt="" coords="17,28,284,47"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.confirm_delete" alt="" coords="17,47,284,65"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.field_attributes" alt="" coords="17,65,284,84"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.fields" alt="" coords="17,84,284,103"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.form" alt="" coords="17,103,284,121"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.form_actions" alt="" coords="17,121,284,140"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.form_display" alt="" coords="17,140,284,159"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.form_size" alt="" coords="17,159,284,177"/>
<area shape="rect" href="javascript:void(0);" title="hash(x)" alt="" coords="17,177,284,196"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.list_actions" alt="" coords="17,196,284,215"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.list_charts" alt="" coords="17,215,284,233"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.list_display" alt="" coords="17,233,284,252"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.list_filter" alt="" coords="17,252,284,271"/>
<area shape="rect" href="javascript:void(0);" title="hash(x)" alt="" coords="17,289,284,308"/>
<area shape="rect" href="javascript:void(0);" title="then the default application_admin is taken :param entity: the entity class for which this admin instance is to be used" alt="" coords="17,311,284,329"/>
<area shape="rect" href="javascript:void(0);" title="repr(x)" alt="" coords="17,329,284,348"/>
<area shape="rect" href="javascript:void(0);" title="str(x)" alt="" coords="17,348,284,367"/>
<area shape="rect" href="javascript:void(0);" title="Add an entity instance as a managed entity instance" alt="" coords="17,367,284,385"/>
<area shape="rect" href="javascript:void(0);" title="Creates a Qt widget containing a form view, for a specific index in a model.  Use this method to create a form view for a collection of objects, the user will be able to use PgUp/PgDown to move to the next object." alt="" coords="17,385,284,404"/>
<area shape="rect" href="javascript:void(0);" title="Create a Qt widget containing a form to create a new instance of the entity related to this admin class" alt="" coords="17,404,284,423"/>
<area shape="rect" href="javascript:void(0);" title="Create a form view for a single object, PgUp/PgDown will do nothing." alt="" coords="17,423,284,441"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.create_validator" alt="" coords="17,441,284,460"/>
<area shape="rect" href="javascript:void(0);" title="A dictionary of (field_name:field_attributes) for all fields that can possibly appear in a list or a form or for which field attributes have been defined" alt="" coords="17,460,284,479"/>
<area shape="rect" href="javascript:void(0);" title="The columns to be displayed in the list view, returns a list of pairs of the name of the field and its attributes needed to display it properly" alt="" coords="17,479,284,497"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.get_confirm_delete" alt="" coords="17,497,284,516"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.get_entity_admin" alt="" coords="17,516,284,535"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.get_fields" alt="" coords="17,535,284,553"/>
<area shape="rect" href="javascript:void(0);" title="camelot.admin.object_admin.ObjectAdmin.get_verbose_name_plural" alt="" coords="17,572,284,591"/>
<area shape="rect" href="javascript:void(0);" title="The ObjectAdmin class describes the interface that will be used to interact with objects of a certain class." alt="" coords="16,11,285,592"/>
<area shape="rect" href="camelot.admin.validator.entity_validator.EntityValidator-class.html" title="A validator class validates an entity before flushing it to the database and provides the user with feedback if the entity is not ready to flush" alt="" coords="20,639,281,657"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_query" title="displayed in the table or the selection view.  Overwrite this method to change the default query, which selects all rows in the database." alt="" coords="20,660,281,679"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_subclass_entity_admin" title="Get the admin class for an entity that is a subclass of this admin's entity or this admin's entity itself." alt="" coords="20,679,281,697"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_subclasses" title="Returns admin objects for the subclasses of the Entity represented by this admin object." alt="" coords="20,697,281,716"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_verbose_identifier" title="Create an identifier for an object that is interpretable for the user, eg : the 'id' of an object.  This verbose identifier can be used to generate a title for a form view of an object." alt="" coords="20,716,281,735"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_field_attributes" title="Get the attributes needed to visualize the field field_name :param field_name: the name of the field" alt="" coords="20,735,281,753"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_list_charts" title="Camelot.camelot.view.elixir_admin.EntityAdmin.get_list_charts" alt="" coords="20,753,281,772"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_filters" title="Returns the filters applicable for these entities each filter is" alt="" coords="20,772,281,791"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#set_defaults" title="Set the defaults of an object :param include_nullable_fields: also set defaults for nullable fields, depending on the context, this should be set to False to allow the user to set the field to None" alt="" coords="20,791,281,809"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#create_select_view" title="Returns a Qt widget that can be used to select an element from a query" alt="" coords="20,809,281,828"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#create_table_view" title="Returns a Qt widget containing a table view, for a certain query, using this Admin class; the table widget contains a model QueryTableModel" alt="" coords="20,828,281,847"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#delete" title="Delete an entity instance" alt="" coords="20,847,281,865"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#flush" title="Flush the pending changes of this entity instance to the backend" alt="" coords="20,865,281,884"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#copy" title="Duplicate this entity instance" alt="" coords="20,884,281,903"/>
<area shape="rect" href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html" title="Admin class specific for classes that are mapped by sqlalchemy. This allows for much more introspection than the standard ObjectAdmin." alt="" coords="19,621,283,904"/>
</map>
<img src="uml_class_diagram_for_camelot__220.gif" alt='' usemap="#uml_class_diagram_for_camelot__220" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
Admin class specific for classes that are mapped by sqlalchemy.
This allows for much more introspection than the standard ObjectAdmin.
<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Nested Classes</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="camelot.admin.validator.entity_validator.EntityValidator-class.html" class="summary-name">validator</a><br />
A validator class validates an entity before flushing it to the database
and provides the user with feedback if the entity is not ready to flush
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>camelot.admin.object_admin.ObjectAdmin</code></b>:
<code><a href="camelot.view.proxy.collection_proxy.CollectionProxy-class.html">model</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_query" class="summary-sig-name">get_query</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
displayed in the table or the selection view. Overwrite this method to
change the default query, which selects all rows in the database.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_query">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_subclass_entity_admin" class="summary-sig-name">get_subclass_entity_admin</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Get the admin class for an entity that is a subclass of this admin's
entity or this admin's entity itself.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_subclass_entity_admin">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_subclasses" class="summary-sig-name">get_subclasses</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Returns admin objects for the subclasses of the Entity represented
by this admin object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_subclasses">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_verbose_identifier" class="summary-sig-name">get_verbose_identifier</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Create an identifier for an object that is interpretable
for the user, eg : the 'id' of an object. This verbose identifier can
be used to generate a title for a form view of an object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_verbose_identifier">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_field_attributes" class="summary-sig-name">get_field_attributes</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Get the attributes needed to visualize the field field_name
:param field_name: the name of the field</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_field_attributes">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_list_charts" class="summary-sig-name">get_list_charts</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_list_charts">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#get_filters" class="summary-sig-name">get_filters</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Returns the filters applicable for these entities each filter is</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_filters">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#set_defaults" class="summary-sig-name">set_defaults</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Set the defaults of an object
:param include_nullable_fields: also set defaults for nullable fields, depending
on the context, this should be set to False to allow the user to set the field
to None</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.set_defaults">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#create_select_view" class="summary-sig-name">create_select_view</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Returns a Qt widget that can be used to select an element from a
query</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.create_select_view">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#create_table_view" class="summary-sig-name">create_table_view</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Returns a Qt widget containing a table view, for a certain query,
using this Admin class; the table widget contains a model
QueryTableModel</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.create_table_view">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Delete an entity instance</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.delete">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#flush" class="summary-sig-name">flush</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Flush the pending changes of this entity instance to the backend</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.flush">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.elixir_admin.EntityAdmin-class.html#copy" class="summary-sig-name">copy</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Duplicate this entity instance</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.copy">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>camelot.admin.object_admin.ObjectAdmin</code></b>:
<code>__init__</code>,
<code>__repr__</code>,
<code>__str__</code>,
<code>add</code>,
<code>create_form_view</code>,
<code>create_new_view</code>,
<code>create_object_form_view</code>,
<code>create_validator</code>,
<code>get_all_fields_and_attributes</code>,
<code>get_columns</code>,
<code>get_confirm_delete</code>,
<code>get_entity_admin</code>,
<code>get_fields</code>,
<code>get_form_actions</code>,
<code>get_form_display</code>,
<code>get_list_actions</code>,
<code>get_name</code>,
<code>get_related_entity_admin</code>,
<code>get_subclass_tree</code>,
<code>get_verbose_name</code>,
<code>get_verbose_name_plural</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>camelot.admin.object_admin.ObjectAdmin</code></b>:
<code>TableView</code>,
<code>confirm_delete</code>,
<code>field_attributes</code>,
<code>fields</code>,
<code>form</code>,
<code>form_actions</code>,
<code>form_display</code>,
<code>form_size</code>,
<code>form_title_column</code>,
<code>list_actions</code>,
<code>list_charts</code>,
<code>list_display</code>,
<code>list_filter</code>,
<code>list_search</code>,
<code>list_size</code>,
<code>name</code>,
<code>verbose_name</code>,
<code>verbose_name_plural</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="get_query"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_query</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_query">source code</a></span>
</td>
</tr></table>
displayed in the table or the selection view. Overwrite this method to
change the default query, which selects all rows in the database.
<dl class="fields">
<dt>Returns:</dt>
<dd>an sqlalchemy query for all the objects that should be</dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="get_subclass_entity_admin"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_subclass_entity_admin</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_subclass_entity_admin">source code</a></span>
</td>
</tr></table>
Get the admin class for an entity that is a subclass of this admin's
entity or this admin's entity itself.
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="get_subclasses"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_subclasses</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_subclasses">source code</a></span>
</td>
</tr></table>
Returns admin objects for the subclasses of the Entity represented
by this admin object.
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="get_verbose_identifier"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_verbose_identifier</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_verbose_identifier">source code</a></span>
</td>
</tr></table>
Create an identifier for an object that is interpretable
for the user, eg : the 'id' of an object. This verbose identifier can
be used to generate a title for a form view of an object.
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
<dt>Overrides:
camelot.admin.object_admin.ObjectAdmin.get_verbose_identifier
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="get_field_attributes"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_field_attributes</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_field_attributes">source code</a></span>
</td>
</tr></table>
<p>Get the attributes needed to visualize the field field_name
:param field_name: the name of the field</p>
<dl class="rst-docutils">
<dt>those attributes can be:</dt>
<dd><ul class="rst-first rst-last rst-simple">
<li>python_type : the corresponding python type of the object</li>
<li>editable : bool specifying wether the user can edit this field</li>
<li>widget : which widget to be used to render the field</li>
<li>...</li>
</ul>
</dd>
</dl>
<dl class="fields">
<dt>Returns:</dt>
<dd>a dictionary of attributes needed to visualize the field,</dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
<dt>Overrides:
camelot.admin.object_admin.ObjectAdmin.get_field_attributes
</dt>
</dl>
</td></tr></table>
</div>
<a name="get_list_charts"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_list_charts</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_list_charts">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="get_filters"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_filters</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.get_filters">source code</a></span>
</td>
</tr></table>
Returns the filters applicable for these entities each filter is
<dl class="fields">
<dt>Returns:</dt>
<dd>[(filter_name, [(option_name, query_decorator), ...), ... ]</dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="set_defaults"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">set_defaults</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.set_defaults">source code</a></span>
</td>
</tr></table>
Set the defaults of an object
:param include_nullable_fields: also set defaults for nullable fields, depending
on the context, this should be set to False to allow the user to set the field
to None
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
<dt>Overrides:
camelot.admin.object_admin.ObjectAdmin.set_defaults
</dt>
</dl>
</td></tr></table>
</div>
<a name="create_select_view"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">create_select_view</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.create_select_view">source code</a></span>
</td>
</tr></table>
<p>Returns a Qt widget that can be used to select an element from a
query</p>
<p>returned widget has an entity_selected_signal signal that will be fired
when a entity has been selected.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>query</code></strong> - sqlalchemy query object</li>
<li><strong class="pname"><code>parent</code></strong> - the widget that will contain this select view, the</li>
</ul></dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@gui_function</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="create_table_view"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">create_table_view</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.create_table_view">source code</a></span>
</td>
</tr></table>
Returns a Qt widget containing a table view, for a certain query,
using this Admin class; the table widget contains a model
QueryTableModel
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>query_getter</code></strong> - sqlalchemy query object</li>
<li><strong class="pname"><code>parent</code></strong> - the workspace widget that will contain the table view</li>
</ul></dd>
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@gui_function</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.delete">source code</a></span>
</td>
</tr></table>
Delete an entity instance
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
<dt>Overrides:
camelot.admin.object_admin.ObjectAdmin.delete
</dt>
</dl>
</td></tr></table>
</div>
<a name="flush"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">flush</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.flush">source code</a></span>
</td>
</tr></table>
Flush the pending changes of this entity instance to the backend
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
<dt>Overrides:
camelot.admin.object_admin.ObjectAdmin.flush
</dt>
</dl>
</td></tr></table>
</div>
<a name="copy"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">copy</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.elixir_admin-pysrc.html#EntityAdmin.copy">source code</a></span>
</td>
</tr></table>
Duplicate this entity instance
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@model_function</code></li>
</ul></dd>
<dt>Overrides:
camelot.admin.object_admin.ObjectAdmin.copy
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sat Jun 12 15:41:54 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
