diff --git a/.gitattributes b/.gitattributes index 6ae25295a4..ca4bf31f93 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3656,6 +3656,7 @@ ideintf/componentreg.pas svneol=native#text/pascal ideintf/componenttreeview.pas svneol=native#text/pascal ideintf/dbpropedits.pas svneol=native#text/pascal ideintf/docs/formeditingintf.xml svneol=native#text/plain +ideintf/docs/ideoptionsintf.xml svneol=native#text/plain ideintf/fieldseditor.lfm svneol=native#text/plain ideintf/fieldseditor.lrs svneol=native#text/pascal ideintf/fieldseditor.pas svneol=native#text/pascal diff --git a/ideintf/docs/ideoptionsintf.xml b/ideintf/docs/ideoptionsintf.xml new file mode 100644 index 0000000000..c525fbaff7 --- /dev/null +++ b/ideintf/docs/ideoptionsintf.xml @@ -0,0 +1,74 @@ + + + + + + + TAbstractIDEOptions - abstract ancestor for any options class which IDE should know about + To create own options classes inherit them from the TAbstractIDEOptions class. This is so for TEnvironmentOptions, TEditorOptions, THelpOptions which IDE registers itself. + + + + TAbstractIDEOptionsEditor - abstract ancestor for any options frame class which IDE should know about + If there is a need to register an own options frame in IDE options dialog inherit it from the TAbstractIDEOptionEditor which is Frame with predefined methods which must be implemented in the descendant. + + + + GetGroupCaption - class function which returns a caption of the option group in the IDE options dialog + + + + GetInstance - class function which must return an instance of the paticular options class + + + + Check - function which must return True if options are correct and dialog can be closed and False in other case + + + + GetTitle - function which must return a string Title for the options frame + + + + Setup - method which executes on options page showing + Setup controls captions or create dynamic controls or perform another initialization actions when Setup is called. + + + + ReadSettings - method which is called when options frame should load options + Load component values from options in this method. + + + + WriteSettings - method which is called when options frame should save options + Save component values to options in this method. + + + + SupportedOptionsClass - class function which must return an options class which this frame supports + + + + RegisterIDEOptionsGroup - function which registers options class for showing in IDE options dialog + + AGroupIndex: Integer - group index defines the position of the options group among other +AGroupClass: TAbstractIDEOptionsClass - options class +FindFreeIndex: boolean = true - defines whether to search for the free group index starting from the passed value or to use paticular passed value + +Function returns a pointer to the record which IDE stores in the internal list of options classes. + + + + RegisterIDEOptionsEditor - function which registers options frame for showing in the IDE options dialog + + AGroupIndex: Integer; - index of a group where the options frame will be shown +AEditorClass: TAbstractIDEOptionsEditorClass; - options frame to register +AIndex: Integer; - index of the frame defines a position of the frame among other +AParent: Integer = NoParent; - index of the parent options frame if needed +AutoCreateGroup: boolean = false; - create group if not exists (can be used if registration order is not reliable) + +Function returns a pointer to the record which IDE stores in the internal list of options frame classes. + + + +