summaryrefslogtreecommitdiff
path: root/xfa/fxfa/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'xfa/fxfa/README.md')
-rw-r--r--xfa/fxfa/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/xfa/fxfa/README.md b/xfa/fxfa/README.md
new file mode 100644
index 0000000000..b554ce0f43
--- /dev/null
+++ b/xfa/fxfa/README.md
@@ -0,0 +1,46 @@
+xfa/fxfa contains a set of CXFA_LayoutItems that model forms containing widgets.
+
+The main hierarchy in this directory are the form elements:
+
+* CXFA_LayoutItem
+ * CXFA_ContentLayoutItem
+ * CXFA_FFPageView
+ * CXFA_FFWidget
+ * CXFA_FFDraw
+ * CXFA_FFArc
+ * CXFA_FFImage
+ * CXFA_FFLine
+ * CXFA_FFRectangle
+ * CXFA_FFText
+ * CXFA_FFExclGroup
+ * CXFA_FFField
+ * CXFA_FFCheckButton
+ * CXFA_FFComboBox
+ * CXFA_FFImageEdit
+ * CXFA_FFListBox
+ * CXFA_FFPushButton
+ * CXFA_FFSignature
+ * CXFA_FFTextEdit
+ * CXFA_FFBarcode
+ * CXFA_FFDateTimeEdit
+ * CXFA_FFNumericEdit
+ * CXFA_FFPasswordEdit
+ * CXFA_FFSubform
+
+CXFA_FFDraw is the base class for static elements like text and images.
+
+CXFA_FFField is the base class for widgets. It owns a lower level CFWL widget
+instance from xfa/fwl. The correspondence is:
+
+* CXFA_FFCheckButton -> CFWL_CheckBox
+* CXFA_FFComboBox -> CFWL_ComboBox
+* CXFA_FFImageEdit -> CFWL_PictureBox
+* CXFA_FFListBox -> CFWL_ListBox
+* CXFA_FFPushButton -> CFWL_PushButton
+* CXFA_FFSignature -> none
+* CXFA_FFTextEdit -> CFWL_Edit
+ * CXFA_FFBarcode -> CFWL_Barcode
+ * CXFA_FFDateTimeEdit -> CFWL_DateTimePicker
+ * CXFA_FFNumericEdit -> CFWL_Edit
+ * CXFA_FFPasswordEdit > CFWL_Edit
+