Python Reference Guide
 
Loading...
Searching...
No Matches
FBBoxLayout Class Reference

Base class for a line layout (either vertical or horizontal) More...

#include <pyfbsdk_additions.h>

Inheritance diagram for FBBoxLayout:

Public Member Functions

 FBBoxLayout (floworientation)
 
 Add (control, size, customparams)
 Add a control to layout specifying its FIXED size.
 
 AddRelative (control, ratio, customparams)
 Add a control to layout specifying its RATIO.
 
 Remove (control)
 Remove a control from the layout.
 
 RemoveAll ()
 Remove all controls from layout.
 
- Public Member Functions inherited from FBLayout
 FBLayout ()
 Constructor.
 
bool AddRegion (str pName, str pTitle, int pX, FBAttachType pXType, str pXRelative, float pMultX, int pY, FBAttachType pYType, str pYRelative, float pMultY, int pW, FBAttachType pWType, str pWRelative, float pMultW, int pH, FBAttachType pHType, str pHRelative, float pMultH)
 Add a region to the layout.
 
 ClearControl (str pName)
 Remove a control from a region in a visual component.
 
FBVisualComponent GetControl (str pName)
 Get control of a region in a visual component.
 
bool GetRegion (str pName)
 Verify if a region with pName exists.
 
bool GetRegionPositions (str pName, bool pComputed, int pX, int pY, int pW=None, int pH=None)
 Get region pName information (position and size)
 
FBSplitStyle GetSplitStyle (str pName)
 Get a region's splitstyle.
 
bool MoveRegion (str pName, int pX, int pY)
 Move a region.
 
bool RemoveRegion (str pName)
 Remove a region.
 
bool RenameRegion (str pOldName, str pNewName)
 Rename a region.
 
 Restructure (bool pNoMove)
 Force a recomputation of all region placements in the layout.
 
 SetAutoRestructure (bool pAutoRestructure)
 Suspend all automatic layout recomputation.
 
bool SetBorder (str pName, FBBorderStyle pType, bool pShowTitle, bool pInSet, int pWidth, int pSpacing, float pMaxAngle, int pCornerRadius)
 Set border properties for a region.
 
bool SetControl (str pName, FBVisualComponent pComponent)
 Set control of a region to a visual component.
 
bool SetControl (str pName, FBVisualComponent pComponent)
 
bool SetRegionTitle (str pName, str pTitle)
 Set a region's title.
 
bool SetSplitStyle (str pName, FBSplitStyle pRegionType)
 Set a region's splitstyle.
 
bool SetView (str pName, FBVisualComponent pComponent)
 Set view.
 
bool SetView (str pName, FBVisualComponent pComponent)
 
bool SizeRegion (str pName, int pW, int pH)
 Change a region's size.
 
- Public Member Functions inherited from FBVisualComponent
 FBVisualComponent ()
 Constructor.
 
bool AddChild (FBVisualComponent pChild, int pId=0)
 Add a child component.
 
FBVisualComponent GetChild (int pId=0)
 Get a child component.
 
QWidget GetQWidgetAddress ()
 Get internal QWidget.
 
bool IsView ()
 Is component a view?
 
 Refresh (bool pNow=False)
 Refresh component.
 
 ViewExpose ()
 Exposed view callback function.
 
 ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input callback function.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager.
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Additional Inherited Members

- Public Attributes inherited from FBLayout
FBEvent OnIdle
 Event: Idle.

 
FBEvent OnInput
 Event: Input.

 
FBEvent OnPaint
 Event: Paint layout.

 
FBEvent OnPreShow
 Event: PreShow layout.

 
FBEvent OnResize
 Event: Resize layout.

 
FBEvent OnShow
 Event: Show layout.

 
- Public Attributes inherited from FBVisualComponent
str Caption
 Property: Widget caption.

 
bool Enabled
 Read Write Property: Is visual enabled?

 
int Height
 Read Write Property: Height.

 
str Hint
 Read Write Property: Hint to show.

 
int Left
 Read Write Property: Left coordinate.

 
bool ReadOnly
 Read Write Property: Is visual component read only?

 
int Top
 Read Write Property: Top coordinate.

 
bool Visible
 Read Write Property: Is visual component visible?

 
int Width
 Read Write Property: Width.

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

Base class for a line layout (either vertical or horizontal)

This class is made to ease the creation of Tool in Python. It manages
all the 'FBLayout' region stuff (no need to use FBAddRegionParam anymore!).

Generally you just Add a Control to the layout specifying some parameters.

There are 2 kinds of Add: Add with fixed size and AddRelative which ensure
the control Added will occupy a 'percentage' of the available space AFTER the 
fixed space has been assigned.        

Constructor & Destructor Documentation

◆ FBBoxLayout()

FBBoxLayout ( floworientation  )

Member Function Documentation

◆ Add()

Add ( control  ,
size  ,
customparams   
)

Add a control to layout specifying its FIXED size.

customparams: space: space between previous control width: fixed width if layout is vertical based height: fixed height if layout is horizontal based.

◆ AddRelative()

AddRelative ( control  ,
ratio  ,
customparams   
)

Add a control to layout specifying its RATIO.

This means the control will be assigned a size based on the space left when all FIXED size have been allocated.

customparams: space: space between prev control width: fixed width if layout is vertical based height: fixed height if layout is horizontal based.

◆ Remove()

Remove ( control  )

Remove a control from the layout.

◆ RemoveAll()

RemoveAll ( )

Remove all controls from layout.