forks
/
dexed
mirror of https://gitlab.com/basile.b/dexed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc comment

This commit is contained in:
Basile Burg 2015-02-21 04:08:01 +01:00
parent 2be5f71a86
commit 5591907a03
1 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/ce_interfaces.pas
View File

@ -11,7 +11,7 @@ uses
type
(**
* An implementer can save and load some stuffs on application start/quit
* An implementer can save and load some stuffs when Coedit starts/quits
*)
ICESessionOptionsObserver = interface
['ICESessionOptionsObserver']
@ -98,7 +98,7 @@ type
(**
* An implementer can add a mainmenu entry.
* An implementer can add a mai nmenu entry.
*)
ICEMainMenuProvider = interface
['ICEMainMenuProvider']
@ -140,7 +140,7 @@ type
end;
// the option editor use this value as a hint to cast and display an option container
// the option editor uses this value as a hint to cast and display an option container.
TOptionEditorKind = (oekGeneric, oekForm, oekControl);
// event generated by the option editor and passed to an ICEEditableOptions.
// the oeeChange event only happends if the container is oekGeneric.
@ -150,13 +150,13 @@ type
*)
ICEEditableOptions = interface
['ICEEditableOptions']
// the widget wants the category
// the widget wants the category.
function optionedWantCategory(): string;
// the widget wants to know if the options will use a generic editor or a custom form
// the widget wants to know if the options will use a generic editor or a custom form.
function optionedWantEditorKind: TOptionEditorKind;
// the widget wants the custom option editor form or the TPersistent containing the options
// the widget wants the custom option editor TCustomForm, TWinControl or the TPersistent containing the options.
function optionedWantContainer: TPersistent;
// the option editor informs that something has happened
// the option editor informs that something has happened.
procedure optionedEvent(anEvent: TOptionEditorEvent);
end;
(**
@ -169,39 +169,39 @@ type
/// describes the message kind, when Auto implies that a ICELogMessageObserver guess the kind.
/// describes the message kind, 'amkAuto' implies that an ICELogMessageObserver guess the kind.
TCEAppMessageKind = (amkAuto, amkBub, amkInf, amkHint, amkWarn, amkErr);
/// describes the message context. Used by a ICELogMessageObserver to filter the messages.
TCEAppMessageCtxt = (amcAll, amcEdit, amcProj, amcApp, amcMisc);
(**
* Single service given by the messages widget.
* Single service provided by the messages widget.
*)
ICEMessagesDisplay = interface(ICESingleService)
// display a message
// displays a message
procedure message(const aValue: string; aData: Pointer; aCtxt: TCEAppMessageCtxt; aKind: TCEAppMessageKind);
// clear the messages related to the context aCtxt.
// clears the messages related to the context aCtxt.
procedure clearByContext(aCtxt: TCEAppMessageCtxt);
// clear the messages related to the data aData.
// clears the messages related to the data aData.
procedure clearByData(aData: Pointer);
end;
(**
* Single service given by the process-input widget.
* Single service provided by the process-input widget.
*)
ICEProcInputHandler = interface(ICESingleService)
// add an entry to the list of process which can receive an user input
// add an entry to the list of process which can receive an user input.
procedure addProcess(aProcess: TProcess);
// remove an entry
// remove an entry.
procedure removeProcess(aProcess: TProcess);
end;
(**
* Single service related to the collection of document
* Single service related to the documents as a collection.
*)
ICEMultiDocHandler = interface(ICESingleService)
// returns the count of opened document
@ -220,7 +220,7 @@ type
{
subject Primitives:
subject primitives:
A subject cannot necessarly provides all the informations the observers expect.
It can compose using the following "primitives".
@ -253,7 +253,6 @@ type
{
Service getters:
Lazily get the interface of a service when needed or for a punctual usage.
The first overload assign the variable only when not yet set, the second is
designed for a punctual usage, for example if a widget needs the service in
a single and rarely called method.