[fpc-devel] documentation of csInline

[Michael Van Canneyt]

On Sat, 7 Nov 2009, Martin wrote:

> Mattias Gaertner wrote:
>> On Sat, 07 Nov 2009 03:00:42 +0000
>> Martin <fpc at mfriebe.de> wrote:
>>
>> 
>>> On 
>>> http://www.freepascal.org/docs-html/rtl/classes/tcomponent.componentstate.html
>>> 
>>> the following description is found
>>> 
>>>> csInline The component is being loaded as part of a frame
>>>> 
>>> Now looking at the code, I end up with the impression, that csInline
>>> is actually not refering to "part" of frame (which I read: component 
>>> owned/nested in a frame), but rather applies to the frame itself? (or any 
>>> component owning it's children.
>>> 
>>> Line in ReadCompnent:
>>>         if csInline in Result.ComponentState then
>>>           FLookupRoot := Result;
>>> 
>>> and other places too. A component that has csInline, becomes the root for 
>>> all nested components
>>> 
>>> Also "is being loaded". csInline is also used in Writer => so it does not 
>>> seem restricted to being loaded ?
>>> 
>>> Am I missing something essential, or is the documentation misleading?
>>> 
>> 
>> Misleading.
>> csInline: the component is an embedded root component
>> 
> Ah, ok or more to the point (since the above could again be read for a label 
> that is on a frame, where the fram itself is embedded):
>
> "A RootComponent that is embedded in another RootComponent (e.g the instance 
> of a frame on another form)"
>
> Thanks
>
> To the fpc team: Is it worth updating the docs?

It always is. It'll be in time for the 2.4.0 release.

Michael.