Public Member Functions | Static Public Member Functions | List of all members
BSpaceLayoutItem Class Reference

Undocumented class. More...

Inherits BLayoutItem.

Public Member Functions

 BSpaceLayoutItem (BSize minSize, BSize maxSize, BSize preferredSize, BAlignment alignment)
 Undocumented public method. More...
 
 BSpaceLayoutItem (BMessage *archive)
 Undocumented public method. More...
 
virtual ~BSpaceLayoutItem ()
 Undocumented public method. More...
 
virtual BAlignment Alignment ()
 Undocumented public method. More...
 
virtual status_t Archive (BMessage *into, bool deep=true) const
 Undocumented public method. More...
 
virtual BRect Frame ()
 Undocumented public method. More...
 
virtual bool IsVisible ()
 Undocumented public method. More...
 
virtual BSize MaxSize ()
 Undocumented public method. More...
 
virtual BSize MinSize ()
 Undocumented public method. More...
 
virtual BSize PreferredSize ()
 Undocumented public method. More...
 
virtual void SetExplicitAlignment (BAlignment alignment)
 Undocumented public method. More...
 
virtual void SetExplicitMaxSize (BSize size)
 Undocumented public method. More...
 
virtual void SetExplicitMinSize (BSize size)
 Undocumented public method. More...
 
virtual void SetExplicitPreferredSize (BSize size)
 Undocumented public method. More...
 
virtual void SetFrame (BRect frame)
 Undocumented public method. More...
 
virtual void SetVisible (bool visible)
 Undocumented public method. More...
 
- Public Member Functions inherited from BLayoutItem
 BLayoutItem (BMessage *from)
 Archive constructor. More...
 
BLayoutLayout () const
 Returns the BLayout this BLayoutItem resides in. More...
 
virtual status_t Perform (perform_code d, void *arg)
 Perform some action (Internal method defined for binary compatibility purposes).
 
virtual BViewView ()
 Return the BView this item is representing, or NULL if it does not represent any view. More...
 
virtual bool HasHeightForWidth ()
 Returns whether or not this BLayoutItem's height constraints are dependent on its width. More...
 
virtual void GetHeightForWidth (float width, float *min, float *max, float *preferred)
 Get this BLayoutItem's height constraints for a given width. More...
 
void AlignInFrame (BRect frame)
 Position this BLayoutItem within frame, given the value returned by Alignment(), and the size constraints for this item. More...
 
virtual void InvalidateLayout (bool children=false)
 Invalidate the layout of this item, or the object it represents. More...
 
virtual void Relayout (bool immediate=false)
 Relayout any children or onscreen data this item contains. Often this request is forwarded to another object. More...
 
void * LayoutData () const
 Retrieve arbitrary data attached to this BLayoutItem. More...
 
void SetLayoutData (void *data)
 Attach arbitrary data to this BLayoutItem. More...
 
- Public Member Functions inherited from BArchivable
 BArchivable (BMessage *from)
 Constructor. Does important behind-the-scenes work in the unarchiving process. More...
 
 BArchivable ()
 Constructor. Does nothing. More...
 
virtual ~BArchivable ()
 Destructor. Does nothing. More...
 

Static Public Member Functions

static BSpaceLayoutItemCreateGlue ()
 Undocumented public method. More...
 
static BSpaceLayoutItemCreateHorizontalStrut (float width)
 Undocumented public method. More...
 
static BSpaceLayoutItemCreateVerticalStrut (float height)
 Undocumented public method. More...
 
static BArchivableInstantiate (BMessage *from)
 Undocumented public method. More...
 
- Static Public Member Functions inherited from BArchivable
static BArchivableInstantiate (BMessage *archive)
 Static member to restore objects from messages. More...
 

Additional Inherited Members

- Protected Member Functions inherited from BLayoutItem
virtual status_t AllArchived (BMessage *into) const
 Method relating to the use of BArchiver. More...
 
virtual status_t AllUnarchived (const BMessage *from)
 Method relating to the use of BUnarchiver. More...
 
virtual void LayoutInvalidated (bool children)
 Hook called from InvalidateLayout(). More...
 
virtual void AttachedToLayout ()
 Hook called when this object is attached to a BLayout (via BLayout::AddItem()) More...
 
virtual void DetachedFromLayout (BLayout *layout)
 Hook called when this object is attached to a BLayout (via BLayout::RemoveItem()) More...
 
virtual void AncestorVisibilityChanged (bool shown)
 Hook called when this BLayoutItem's ancestors change visibility, effectively hiding or showing this item. More...
 

Detailed Description

Undocumented class.

Since
Haiku R1

Constructor & Destructor Documentation

◆ BSpaceLayoutItem() [1/2]

BSpaceLayoutItem::BSpaceLayoutItem ( BSize  minSize,
BSize  maxSize,
BSize  preferredSize,
BAlignment  alignment 
)

Undocumented public method.

Parameters
minSizeUndocumented
maxSizeUndocumented
preferredSizeUndocumented
alignmentUndocumented
Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

◆ BSpaceLayoutItem() [2/2]

BSpaceLayoutItem::BSpaceLayoutItem ( BMessage archive)

Undocumented public method.

Parameters
archiveUndocumented
Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

◆ ~BSpaceLayoutItem()

BSpaceLayoutItem::~BSpaceLayoutItem ( )
virtual

Undocumented public method.

Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Member Function Documentation

◆ Alignment()

BAlignment BSpaceLayoutItem::Alignment ( )
virtual

Undocumented public method.

Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Implements BLayoutItem.

◆ Archive()

status_t BSpaceLayoutItem::Archive ( BMessage into,
bool  deep = true 
) const
virtual

Undocumented public method.

Parameters
intoUndocumented
deepUndocumented
Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Reimplemented from BLayoutItem.

◆ CreateGlue()

static static BSpaceLayoutItem * BSpaceLayoutItem::CreateGlue ( )
static

Undocumented public method.

Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Referenced by BLayoutBuilder::Group< ParentBuilder >::AddGlue().

◆ CreateHorizontalStrut()

static static BSpaceLayoutItem * BSpaceLayoutItem::CreateHorizontalStrut ( float  width)
static

Undocumented public method.

Parameters
widthUndocumented
Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Referenced by BLayoutBuilder::Group< ParentBuilder >::AddStrut().

◆ CreateVerticalStrut()

static static BSpaceLayoutItem * BSpaceLayoutItem::CreateVerticalStrut ( float  height)
static

Undocumented public method.

Parameters
heightUndocumented
Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Referenced by BLayoutBuilder::Group< ParentBuilder >::AddStrut().

◆ Frame()

BRect BSpaceLayoutItem::Frame ( )
virtual

Undocumented public method.

Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Implements BLayoutItem.

◆ Instantiate()

static static BArchivable * BSpaceLayoutItem::Instantiate ( BMessage from)
static

Undocumented public method.

Parameters
fromUndocumented
Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

◆ IsVisible()

bool BSpaceLayoutItem::IsVisible ( )
virtual

Undocumented public method.

Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Implements BLayoutItem.

◆ MaxSize()

BSize BSpaceLayoutItem::MaxSize ( )
virtual

Undocumented public method.

Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Implements BLayoutItem.

◆ MinSize()

BSize BSpaceLayoutItem::MinSize ( )
virtual

Undocumented public method.

Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Implements BLayoutItem.

◆ PreferredSize()

BSize BSpaceLayoutItem::PreferredSize ( )
virtual

Undocumented public method.

Returns
Undocumented
Return values
<value>Undocumented
Since
Haiku R1

Implements BLayoutItem.

◆ SetExplicitAlignment()

void BSpaceLayoutItem::SetExplicitAlignment ( BAlignment  alignment)
virtual

Undocumented public method.

Parameters
alignmentUndocumented
Since
Haiku R1

Implements BLayoutItem.

◆ SetExplicitMaxSize()

void BSpaceLayoutItem::SetExplicitMaxSize ( BSize  size)
virtual

Undocumented public method.

Parameters
sizeUndocumented
Since
Haiku R1

Implements BLayoutItem.

◆ SetExplicitMinSize()

void BSpaceLayoutItem::SetExplicitMinSize ( BSize  size)
virtual

Undocumented public method.

Parameters
sizeUndocumented
Since
Haiku R1

Implements BLayoutItem.

◆ SetExplicitPreferredSize()

void BSpaceLayoutItem::SetExplicitPreferredSize ( BSize  size)
virtual

Undocumented public method.

Parameters
sizeUndocumented
Since
Haiku R1

Implements BLayoutItem.

◆ SetFrame()

void BSpaceLayoutItem::SetFrame ( BRect  frame)
virtual

Undocumented public method.

Parameters
frameUndocumented
Since
Haiku R1

Implements BLayoutItem.

◆ SetVisible()

void BSpaceLayoutItem::SetVisible ( bool  visible)
virtual

Undocumented public method.

Parameters
visibleUndocumented
Since
Haiku R1

Implements BLayoutItem.