Public Member Functions | List of all members
SplitterHandle Class Reference

SplitterHandle represents the Sash between two layout items managed by a SplitterLayout. More...

#include <SplitterLayout.h>

Inheritance diagram for SplitterHandle:
LayoutControl RefCounted< IRefCounted > IRefCounted GuiSplitterHandle

Public Member Functions

void SetOrientation (LayoutOrientation o)
 Sets the layout orientation. More...
 
LayoutOrientation GetOrientation () const
 Gets the layout orientation. More...
 
SplitterLayoutGetSplitterLayout () const
 Gets the parent layout. More...
 
virtual BSize GetDesiredSize () const override
 Gets the desired size. More...
 
int GetPositionFromPoint (const BPoint &)
 Gets the position based on the given point. More...
 
int GetAdjustedPosition (int offset)
 Gets the position relative to the offset. More...
 
virtual int MoveSplitter (int position)
 Moves the handle to the given position. More...
 
virtual bool PositionWasBound (int givenPosition, int boundPosition, SplitterBoundType boundType)
 Position has been bound to Minimum or Maximum. More...
 
- Public Member Functions inherited from LayoutControl
virtual void Move (const BPoint &)=0
 The Move method is called by the LayoutManager to move the control to a new point. More...
 
virtual void Move (int x, int y)
 
virtual void Resize (const BSize &)=0
 The Resize method is called by the LayoutManager to resize the control. More...
 
virtual void Resize (int w, int h)
 
virtual void ShowIfNotHidden ()=0
 The ShowIfNotHidden method is called by the LayoutManager to show the control. More...
 
virtual BSize GetDesiredMinimumSize () const
 Returns the recommended minimum size for the control. More...
 
virtual BSize GetMinimumSize () const
 Returns the Control's minimum size for layout management. More...
 
virtual int GetMinimumWidth () const
 Returns the Control's minimum width for layout management. More...
 
virtual int GetMinimumHeight () const
 Returns the Control's minimum height for layout management. More...
 
void SetMinimumSize (const BSize &minSize)
 Sets the Control's minimum size for layout management. More...
 
void SetMinimumSize (int minWidth, int minHeight)
 Sets the Control's minimum size for layout management. More...
 
void SetMinimumWidth (int minWidth)
 Sets the Control's minimum width for layout management. More...
 
void SetMinimumHeight (int minHeight)
 Sets the Control's minimum height for layout management. More...
 
virtual BSize GetMaximumSize () const
 Returns the Control's maximum size in pixels. More...
 
virtual int GetMaximumWidth () const
 Returns the Control's maximum width. More...
 
virtual int GetMaximumHeight () const
 Returns the Control's maximum height. More...
 
void SetMaximumSize (const BSize &maxSize)
 Sets the Control's maximum size for layout management. More...
 
void SetMaximumSize (int maxWidth, int maxHeight)
 Sets the Control's maximum size for layout management. More...
 
void SetMaximumWidth (int maxWidth)
 Sets the Control's maximum width for layout management. More...
 
void SetMaximumHeight (int maxHeight)
 Sets the Control's maximum height for layout management. More...
 
virtual int GetHeightForWidth (int width) const
 Returns the preferred height for this control, given a certain width. More...
 
LayoutControlGetParentControl () const
 Returns the parent control of this control. More...
 
void SetParentControl (LayoutControl *parentCtl)
 Sets the parent control of this control. More...
 
virtual BPoint GetPosition () const
 Gets the position of the control within its parent control. More...
 
virtual int GetX () const
 Gets the X position of the control within its parent control. More...
 
virtual int GetY () const
 Gets the Y position of the control within its parent control. More...
 
virtual BSize GetSize () const
 Gets the size of the control. More...
 
virtual int GetWidth () const
 Gets the width of the control. More...
 
virtual int GetHeight () const
 Gets the height of the control. More...
 
void SetSize (const BSize &size)
 Sets the current size of the control. More...
 
virtual BRect GetRect () const
 Gets the internal geometry of the control. More...
 
virtual BRect GetContentsRect () const
 Returns the area inside the control's margins. More...
 
void SetFixedSize (const BSize &size)
 Sets both the minimum and maximum sizes of the control to 'size', thereby preventing it from ever growing or shrinking. More...
 
void SetFixedSize (int width, int height)
 Sets both the minimum and maximum sizes of the control to the given width and height, thereby preventing it from ever growing or shrinking. More...
 
virtual SizePolicyR GetSizePolicy () const
 Gets the SizePolicy, which is a layout attribute describing horizontal and vertical resizing policy. More...
 
void SetSizePolicy (SizePolicy sp)
 Sets the SizePolicy, which is a layout attribute describing horizontal and vertical resizing policy. More...
 
void SetSizePolicy (SizePolicyType horizontal, SizePolicyType vertical)
 Sets the SizePolicy, which is a layout attribute describing horizontal and vertical resizing policy. More...
 
virtual LayoutManagerGetLayout () const
 Gets the LayoutManager controlling the size and position of the contents of this control. More...
 
void SetLayout (LayoutManager *layout)
 Sets the LayoutManager controlling the size and position of the contents of this control. More...
 
virtual LayoutManagerGetParentLayout () const
 Gets the LayoutManager controlling the size and position of this control. More...
 
void SetParentLayout (LayoutManager *layout)
 Sets the LayoutManager controlling the size and position of this control. More...
 
Margins GetMargins () const
 Gets the Margins property, which defines the four margins around the control's rectangle. More...
 
void GetMargins (int *left, int *top, int *right, int *bottom) const
 Gets the Margins values independently. More...
 
int GetLeftMargin () const
 Gets the left margin. More...
 
int GetRightMargin () const
 Gets the right margin. More...
 
int GetTopMargin () const
 Gets the top margin. More...
 
int GetBottomMargin () const
 Gets the bottom margin. More...
 
int GetMargin (LayoutMargin lm) const
 Gets the appropriate margin, based on the given LayoutMargin. More...
 
void SetMargin (int margin)
 Sets the Margins property, which defines the four margins around the control's rectangle. More...
 
void SetMargins (const Margins &margins)
 Sets the Margins property, which defines the four margins around the control's rectangle. More...
 
void SetMargins (int left, int top, int right, int bottom)
 Sets the Margins property, which defines the four margins around the control's rectangle. More...
 
virtual int GetSpacing (LayoutSpacing pm) const
 Gets the Spacing property, which defines the distance between controls in a layout. More...
 
virtual BRect GetGeometry () const
 Gets the Geometry property, which defines the rectangle within the parent control. More...
 
virtual void SetGeometry (const BRect &rect)
 Sets the Geometry property, which defines the rectangle within the parent control. More...
 
void SetGeometry (int x, int y, int w, int h)
 Sets the Geometry property, which defines the rectangle within the parent control. More...
 
void UpdateGeometry ()
 Notifies the layout system that this LayoutControl has changed and may need to change geometry. More...
 
void UpdateGeometry (bool forceUpdate)
 Notifies the layout system that this LayoutControl has changed and may need to change geometry. More...
 
virtual void Invalidate ()
 Invalidates the layout item then updates it. More...
 
virtual void SetDirty ()
 Invalidates the layout item without updating it. More...
 
virtual bool IsEnabled () const
 Determines if the LayoutControl is enabled. More...
 
void SetEnabled (bool)
 Sets whether the LayoutControl is enabled. More...
 
virtual bool IsHidden () const
 Determines if the LayoutControl is hidden. More...
 
void SetHidden (bool)
 Sets whether the LayoutControl is hidden. More...
 
virtual bool IsVisible () const
 Determines if the LayoutControl is visible. More...
 
void SetVisible (bool)
 Sets whether the LayoutControl is visible. More...
 
bool IsLaidOut () const
 Determines if the LayoutControl is laid out. More...
 
void SetLaidOut (bool)
 Sets whether the LayoutControl is laid out. More...
 
virtual bool IsWindow () const
 Determines if the LayoutControl is a Window. More...
 
void SetIsWindow (bool)
 Sets whether the LayoutControl is a Window. More...
 
virtual bool UseTrueRect () const
 Determines if the LayoutManager should use the parent control's geometry when resizing this control. More...
 
void SetUseTrueRect (bool)
 Sets whether the LayoutManager should use the parent control's geometry when resizing this control. More...
 
bool WasResized () const
 Determines if the LayoutControl has been resized. More...
 
LayoutItemGetLayoutItem () const
 Gets the LayoutItem associated with this LayoutControl. More...
 
- Public Member Functions inherited from RefCounted< IRefCounted >
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 
UInt32 AddRef () const
 
UInt32 Release () const
 
 RefCounted ()
 
 RefCounted (RefCounted const &rhs)
 
RefCountedoperator= (RefCounted const &rhs)
 
UInt32 GetRefCount () const
 

Additional Inherited Members

- Protected Member Functions inherited from RefCounted< IRefCounted >
virtual ~RefCounted ()
 
- Protected Member Functions inherited from IRefCounted
virtual ~IRefCounted ()
 
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 

Detailed Description

SplitterHandle represents the Sash between two layout items managed by a SplitterLayout.

Member Function Documentation

int GetAdjustedPosition ( int  offset)

Gets the position relative to the offset.

virtual BSize GetDesiredSize ( ) const
overridevirtual

Gets the desired size.

Reimplemented from LayoutControl.

LayoutOrientation GetOrientation ( ) const

Gets the layout orientation.

int GetPositionFromPoint ( const BPoint )

Gets the position based on the given point.

SplitterLayout* GetSplitterLayout ( ) const

Gets the parent layout.

virtual int MoveSplitter ( int  position)
virtual

Moves the handle to the given position.

Parameters
[in]positionThe new position of the SplitterHandle.

Reimplemented in GuiSplitterHandle.

virtual bool PositionWasBound ( int  givenPosition,
int  boundPosition,
SplitterBoundType  boundType 
)
virtual

Position has been bound to Minimum or Maximum.

This gives the SplitterHandle a chance to compensate.

Parameters
[in]givenPositionThe position provided to MoveSplitter.
[in]boundPositionThe bound position.
[in]boundTypeThe type of bound action.
Returns
Whether or not the adjustment was handled.

Reimplemented in GuiSplitterHandle.

void SetOrientation ( LayoutOrientation  o)

Sets the layout orientation.


The documentation for this class was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.