libyui  3.3.1
YPartitionSplitter Class Referenceabstract

PartitionSplitter: A (very custom) widget for easily splitting one existing partition into two. More...

#include <YPartitionSplitter.h>

Inheritance diagram for YPartitionSplitter:
Collaboration diagram for YPartitionSplitter:

Public Member Functions

virtual ~YPartitionSplitter ()
 Destructor.
 
virtual const char * widgetClass () const
 Returns a descriptive name of this widget class for logging, debugging etc.
 
virtual int value ()=0
 The value of this PartitionSplitter: The size of the new partition. More...
 
virtual void setValue (int newValue)=0
 Set the value (the size of the new partition). More...
 
int usedSize () const
 
int totalFreeSize () const
 
int minFreeSize () const
 
int maxFreeSize () const
 
int freeSize ()
 
int newPartSize ()
 
int minNewPartSize () const
 
int maxNewPartSize () const
 
std::string usedLabel () const
 
std::string freeLabel () const
 
std::string newPartLabel () const
 
std::string freeFieldLabel () const
 
std::string newPartFieldLabel () const
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 Set a property. More...
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 Get a property. More...
 
virtual const YPropertySetpropertySet ()
 Return this class's property set. More...
 
const char * userInputProperty ()
 The name of the widget property that will return user input. More...
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 Destructor.
 
virtual std::string debugLabel () const
 Returns a descriptive label of this widget instance. More...
 
std::string helpText () const
 Return the help text for this widget.
 
void setHelpText (const std::string &helpText)
 Set a help text for this widget. More...
 
bool hasChildren () const
 Returns 'true' if this widget has any children.
 
YWidgetfirstChild () const
 Returns the first child or 0 if there is none. More...
 
YWidgetlastChild () const
 Returns the last child or 0 if there is none.
 
YWidgetListIterator childrenBegin () const
 Return an iterator that points to the first child or to childrenEnd() if there are no children.
 
YWidgetListIterator childrenEnd () const
 Return an interator that points after the last child.
 
YWidgetListConstIterator childrenConstBegin () const
 Return a const iterator that points to the first child or to childrenEnd() if there are no children.
 
YWidgetListConstIterator childrenConstEnd () const
 Return a const interator that points after the last child.
 
YWidgetListIterator begin ()
 A helper for the range-based "for" loop. More...
 
YWidgetListIterator end ()
 A helper for the range-based "for" loop. More...
 
int childrenCount () const
 Returns the current number of children.
 
bool contains (YWidget *child) const
 Checks if 'child' is a (direct!) child of this widget.
 
virtual void addChild (YWidget *child)
 Add a new child. More...
 
virtual void removeChild (YWidget *child)
 Remove a child. More...
 
void deleteChildren ()
 Delete all children and remove them from the children manager's list.
 
YWidgetparent () const
 Return this widget's parent or 0 if it doesn't have a parent.
 
bool hasParent () const
 Return 'true' if this widget has a parent, 'false' if not.
 
void setParent (YWidget *newParent)
 Set this widget's parent.
 
YDialogfindDialog ()
 Traverse up the widget hierarchy and find the dialog this widget belongs to. More...
 
YWidgetfindWidget (YWidgetID *id, bool doThrow=true) const
 Recursively find a widget by its ID. More...
 
virtual int preferredWidth ()=0
 Preferred width of the widget. More...
 
virtual int preferredHeight ()=0
 Preferred height of the widget. More...
 
virtual int preferredSize (YUIDimension dim)
 Preferred size of the widget in the specified dimension. More...
 
virtual void setSize (int newWidth, int newHeight)=0
 Set the new size of the widget. More...
 
bool isValid () const
 Checks whether or not this object is valid. More...
 
bool beingDestroyed () const
 Check if this widget is in the process of being destroyed.
 
void * widgetRep () const
 Return a pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget.
 
void setWidgetRep (void *toolkitWidgetRep)
 Set the pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. More...
 
bool hasId () const
 Returns 'true' if this widget has an ID.
 
YWidgetIDid () const
 Returns this widget's ID.
 
void setId (YWidgetID *newId_disown)
 Set this widget's ID. More...
 
virtual void setEnabled (bool enabled=true)
 Enable or disable this widget, i.e. More...
 
void setDisabled ()
 Disable this widget (overloaded for better readability).
 
virtual bool isEnabled () const
 Returns 'true' if this widget is enabled.
 
virtual bool stretchable (YUIDimension dim) const
 This is a boolean value that determines whether the widget is resizable beyond its preferred size in the specified dimension. More...
 
void setStretchable (YUIDimension dim, bool newStretch)
 Set the stretchable state to "newStretch" regardless of any hstretch or vstretch options.
 
void setDefaultStretchable (YUIDimension dim, bool newStretch)
 Set the stretchable state to "newStretch". More...
 
virtual int weight (YUIDimension dim)
 The weight is used in situations where all widgets can get their preferred size and yet space is available. More...
 
bool hasWeight (YUIDimension dim)
 Return whether or not the widget has a weight in the specified dimension.
 
void setWeight (YUIDimension dim, int weight)
 Set a weight in the specified dimension.
 
void setNotify (bool notify=true)
 Sets the Notify property.
 
bool notify () const
 Returns whether the widget will notify, i.e. More...
 
void setNotifyContextMenu (bool notifyContextMenu=true)
 Sets the notifyContextMenu property.
 
bool notifyContextMenu () const
 Returns whether the widget will send an event when the user clicks selects the context menu e.g. More...
 
bool sendKeyEvents () const
 Returns 'true' if this widget should send key events, i.e. More...
 
void setSendKeyEvents (bool doSend)
 Specify whether or not this widget should send key events.
 
bool autoShortcut () const
 Returns 'true' if a keyboard shortcut should automatically be assigned to this widget - without complaints in the log file.
 
void setAutoShortcut (bool _newAutoShortcut)
 Sets the 'autoShortcut' flag.
 
int functionKey () const
 Return a function key number that is assigned to this widget. More...
 
bool hasFunctionKey () const
 Check if a function key is assigned to this widget.
 
virtual void setFunctionKey (int fkey_no)
 Assign a function key to this widget (1 for F1, 2 for F2, etc. More...
 
virtual bool setKeyboardFocus ()
 Set the keyboard focus to this widget. More...
 
virtual std::string shortcutString () const
 Get the string of this widget that holds the keyboard shortcut, if any. More...
 
virtual void setShortcutString (const std::string &str)
 Set the string of this widget that holds the keyboard shortcut, if any. More...
 
void dumpWidgetTree (int indentationLevel=0)
 Debugging function: Dump the widget tree from here on to the log file.
 
void dumpDialogWidgetTree ()
 Debugging function: Dump the widget tree from this widget's dialog parent. More...
 
void setChildrenEnabled (bool enabled)
 Enable or disable all widgets in this widget tree.
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 Recursively save the user input of all child widgets to a macro recorder: More...
 
void * operator new (size_t size)
 Overloaded operator new to ensure widgets are always created on the heap, never on the stack. More...
 
virtual void startMultipleChanges ()
 In some UIs updating the screen content is an expensive operation. More...
 
virtual void doneMultipleChanges ()
 

Protected Member Functions

 YPartitionSplitter (YWidget *parent, int usedSize, int totalFreeSize, int newPartSize, int minNewPartSize, int minFreeSize, const std::string &usedLabel, const std::string &freeLabel, const std::string &newPartLabel, const std::string &freeFieldLabel, const std::string &newPartFieldLabel)
 Constructor. More...
 
- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 Constructor.
 
YWidgetChildrenManagerchildrenManager () const
 Returns this widget's children manager.
 
void setChildrenManager (YWidgetChildrenManager *manager)
 Sets a new children manager for this widget. More...
 
void setBeingDestroyed ()
 Set the "being destroyed" flag, i.e. More...
 
void dumpWidget (YWidget *w, int indentationLevel)
 Helper function for dumpWidgetTree(): Dump one widget to the log file.
 

Detailed Description

PartitionSplitter: A (very custom) widget for easily splitting one existing partition into two.

Layout:

+--------------------+---------------+--------------------------+
| Old Partition      | Old Partition | New Partition            |
| used               | free          |                          |
+--------------------+---------------+--------------------------+

Old Partition free                                  New Partition
[ 123 ] ================O================================ [ 123 ]

At the top, there is a BarGraph that dynamicylla displays the sizes in graphical form. Below are an IntField to the left and an IntField to the right, each with its respective label. Between the two IntFields there is a Slider.

The user can enter a value in either IntField or drag the slider. The other sub-widgets (including the BarGraph) will automatically be adjusted. Visually (in the BarGraph), the border between "old partition free" and "new partition" will move left and right. The border between "old partition used" and "old partition free" is static.

There are built-in (configurable) limits for the minimum sizes of "old partition free" and "new partition".

Definition at line 63 of file YPartitionSplitter.h.

Constructor & Destructor Documentation

◆ YPartitionSplitter()

YPartitionSplitter::YPartitionSplitter ( YWidget parent,
int  usedSize,
int  totalFreeSize,
int  newPartSize,
int  minNewPartSize,
int  minFreeSize,
const std::string &  usedLabel,
const std::string &  freeLabel,
const std::string &  newPartLabel,
const std::string &  freeFieldLabel,
const std::string &  newPartFieldLabel 
)
protected

Constructor.

usedSize: Used size of the old partition (constant)

totalFreeSize: Total free size of the old partition before the split: OldPartitionFree + NewPartition

newPartSize': Initial size of the new partition

minNewPartSize: Miminum size of the new partition

minFreeSize: Minimum free size of the old partition

usedLabel: BarGraph label for the used part of the old partition

freeLabel: BarGraph label for the free part of the old partition

newPartLabel: BarGraph label for the new partition

freeFieldLabel: IntField label for the free part of the old partition

newPartFieldLabel: IntField label for the size of the new partition

Definition at line 69 of file YPartitionSplitter.cc.

Here is the call graph for this function:

Member Function Documentation

◆ getProperty()

YPropertyValue YPartitionSplitter::getProperty ( const std::string &  propertyName)
virtual

Get a property.

Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 193 of file YPartitionSplitter.cc.

Here is the call graph for this function:

◆ propertySet()

const YPropertySet & YPartitionSplitter::propertySet ( )
virtual

Return this class's property set.

This also initializes the property upon the first call.

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 160 of file YPartitionSplitter.cc.

Here is the call graph for this function:

◆ setProperty()

bool YPartitionSplitter::setProperty ( const std::string &  propertyName,
const YPropertyValue val 
)
virtual

Set a property.

Reimplemented from YWidget.

This function may throw YUIPropertyExceptions.

This function returns 'true' if the value was successfully set and 'false' if that value requires special handling (not in error cases: those are covered by exceptions).

Reimplemented from YWidget.

Definition at line 178 of file YPartitionSplitter.cc.

Here is the call graph for this function:

◆ setValue()

virtual void YPartitionSplitter::setValue ( int  newValue)
pure virtual

Set the value (the size of the new partition).

Derived classes are required to implement this.

◆ userInputProperty()

const char* YPartitionSplitter::userInputProperty ( )
inlinevirtual

The name of the widget property that will return user input.

Inherited from YWidget.

Reimplemented from YWidget.

Definition at line 181 of file YPartitionSplitter.h.

◆ value()

virtual int YPartitionSplitter::value ( )
pure virtual

The value of this PartitionSplitter: The size of the new partition.

Derived classes are required to implement this.


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