libyui
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
YSpacing Class Reference

#include <YSpacing.h>

Inheritance diagram for YSpacing:
Inheritance graph
[legend]
Collaboration diagram for YSpacing:
Collaboration graph
[legend]

Public Member Functions

 YSpacing (YWidget *parent, YUIDimension dim, bool stretchable=false, YLayoutSize_t layoutUnits=0.0)
 
virtual ~YSpacing ()
 
virtual const char * widgetClass () const
 
YUIDimension dimension () const
 
int size () const
 
int size (YUIDimension dim) const
 
virtual int preferredWidth ()
 
virtual int preferredHeight ()
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 
virtual std::string debugLabel () const
 
std::string helpText () const
 
void setHelpText (const std::string &helpText)
 
virtual const YPropertySet & propertySet ()
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
bool hasChildren () const
 
YWidget * firstChild () const
 
YWidget * lastChild () const
 
YWidgetListIterator childrenBegin () const
 
YWidgetListIterator childrenEnd () const
 
YWidgetListConstIterator childrenConstBegin () const
 
YWidgetListConstIterator childrenConstEnd () const
 
YWidgetListIterator begin ()
 
YWidgetListIterator end ()
 
int childrenCount () const
 
bool contains (YWidget *child) const
 
virtual void addChild (YWidget *child)
 
virtual void removeChild (YWidget *child)
 
void deleteChildren ()
 
YWidget * parent () const
 
bool hasParent () const
 
void setParent (YWidget *newParent)
 
YDialog * findDialog ()
 
YWidget * findWidget (YWidgetID *id, bool doThrow=true) const
 
virtual int preferredSize (YUIDimension dim)
 
virtual void setSize (int newWidth, int newHeight)=0
 
bool isValid () const
 
bool beingDestroyed () const
 
void * widgetRep () const
 
void setWidgetRep (void *toolkitWidgetRep)
 
bool hasId () const
 
YWidgetID * id () const
 
void setId (YWidgetID *newId_disown)
 
virtual void setEnabled (bool enabled=true)
 
void setDisabled ()
 
virtual bool isEnabled () const
 
virtual bool stretchable (YUIDimension dim) const
 
void setStretchable (YUIDimension dim, bool newStretch)
 
void setDefaultStretchable (YUIDimension dim, bool newStretch)
 
virtual int weight (YUIDimension dim)
 
bool hasWeight (YUIDimension dim)
 
void setWeight (YUIDimension dim, int weight)
 
void setNotify (bool notify=true)
 
bool notify () const
 
void setNotifyContextMenu (bool notifyContextMenu=true)
 
bool notifyContextMenu () const
 
bool sendKeyEvents () const
 
void setSendKeyEvents (bool doSend)
 
bool autoShortcut () const
 
void setAutoShortcut (bool _newAutoShortcut)
 
int functionKey () const
 
bool hasFunctionKey () const
 
virtual void setFunctionKey (int fkey_no)
 
virtual bool setKeyboardFocus ()
 
virtual std::string shortcutString () const
 
virtual void setShortcutString (const std::string &str)
 
virtual const char * userInputProperty ()
 
void dumpWidgetTree (int indentationLevel=0)
 
void dumpDialogWidgetTree ()
 
void setChildrenEnabled (bool enabled)
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 
void * operator new (size_t size)
 
void operator delete (void *ptr) noexcept
 
virtual void startMultipleChanges ()
 
virtual void doneMultipleChanges ()
 

Additional Inherited Members

- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 
YWidgetChildrenManager * childrenManager () const
 
void setChildrenManager (YWidgetChildrenManager *manager)
 
void setBeingDestroyed ()
 
void dumpWidget (YWidget *w, int indentationLevel)
 

Detailed Description

HSpacing, VSpacing, HStretch, VStretch

Constructor & Destructor Documentation

◆ YSpacing()

YSpacing::YSpacing ( YWidget * parent,
YUIDimension dim,
bool stretchable = false,
YLayoutSize_t layoutUnits = 0.0 )

Constructor.

A Spacing/Stretch widget works only in one dimension ('dim') at the same time. But it can be stretchable and have a size at the same time, in which case the specified size acts very much like a minimal size - but not exactly, since YLayoutBox will reduce Spacings first before other widgets have to be resized below their preferred size.

'layoutUnits' is specified in abstract UI units where a main window (800x600 pixels in the Qt UI) corresponds to a 80x25 window.

◆ ~YSpacing()

YSpacing::~YSpacing ( )
virtual

Destructor.

Member Function Documentation

◆ dimension()

YUIDimension YSpacing::dimension ( ) const

Return the primary dimension of this Spacing/Stretch, i.e. the dimension in which it uses space or stretches.

◆ preferredHeight()

int YSpacing::preferredHeight ( )
virtual

Preferred height of the widget.

Reimplemented from YWidget.

Implements YWidget.

◆ preferredWidth()

int YSpacing::preferredWidth ( )
virtual

Preferred width of the widget.

Reimplemented from YWidget.

Implements YWidget.

◆ size() [1/2]

int YSpacing::size ( ) const

Return the size in the primary dimension.

This is the device dependent size (pixels or character cells), not the abstract UI layout unit from the constructor.

◆ size() [2/2]

int YSpacing::size ( YUIDimension dim) const

Return the size in the specified dimension.

This is the device dependent size (pixels or character cells), not the abstract UI layout unit from the constructor.

◆ widgetClass()

const char * YSpacing::widgetClass ( ) const
virtual

Return a descriptive name of this widget class for logging, debugging etc.

Reimplemented from YWidget.

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