35 #define YWizardID "wizard"
36 #define YWizardContentsReplacePointID "contents"
44 YWizardMode_TitleOnLeft
102 const std::string & backButtonLabel,
103 const std::string & abortButtonLabel,
104 const std::string & nextButtonLabel,
105 YWizardMode
wizardMode = YWizardMode_Standard );
174 virtual void setDialogIcon(
const std::string & iconName ) = 0;
197 virtual void addStep(
const std::string & text,
const std::string &
id ) = 0;
234 virtual void addTreeItem(
const std::string & parentID,
235 const std::string & text,
236 const std::string &
id ) = 0;
265 virtual void addMenu(
const std::string & text,
266 const std::string &
id ) = 0;
271 virtual void addSubMenu(
const std::string & parentMenuID,
272 const std::string & text,
273 const std::string &
id ) = 0;
279 virtual void addMenuEntry(
const std::string & parentMenuID,
280 const std::string & text,
281 const std::string &
id ) = 0;
299 const std::string &
id ) = 0;
virtual void setDialogHeading(const std::string &headingText)=0
Set the dialog heading.
virtual YReplacePoint * contentsReplacePoint() const =0
Return the internal contents ReplacePoint.
virtual void deleteTreeItems()=0
Delete all tree items.
void ping()
NOP command to check if a YWizard is running.
Abstract base class for macro recorders.
virtual void addStep(const std::string &text, const std::string &id)=0
Add a step for the steps panel on the side bar.
virtual void deleteMenus()=0
Delete all menus and hide the menu bar.
virtual void setDialogTitle(const std::string &titleText)=0
Set the dialog title shown in the window manager's title bar.
Transport class for the value of simple properties.
bool nextButtonIsProtected() const
Check if the wizard's "Next" button is currently protected against disabling.
A set of properties to check names and types against.
YWizard(YWidget *parent, const std::string &backButtonLabel, const std::string &abortButtonLabel, const std::string &nextButtonLabel, YWizardMode wizardMode=YWizardMode_Standard)
Constructor.
virtual void updateSteps()=0
Update the steps display: Reflect the internal steps and heading lists in the layout.
virtual ~YWizard()
Destructor.
virtual void setButtonLabel(YPushButton *button, const std::string &newLabel)
Set the label of one of the wizard buttons (backButton(), abortButton(), nextButton() ) if that butto...
virtual void addMenuEntry(const std::string &parentMenuID, const std::string &text, const std::string &id)=0
Add a menu entry to the menu with ID 'parentMenuID'.
virtual void addSubMenu(const std::string &parentMenuID, const std::string &text, const std::string &id)=0
Add a submenu to the menu with ID 'parentMenuID'.
virtual const YPropertySet & propertySet()
Return this class's property set.
virtual void addTreeItem(const std::string &parentID, const std::string &text, const std::string &id)=0
Add a tree item.
virtual void addStepHeading(const std::string &text)=0
Add a step heading for the steps panel on the side bar.
YWizardMode wizardMode() const
Return the wizard mode (what kind of wizard this is): YWizardMode_Standard, YWizardMode_Steps, YWizardMode_Tree, YWizardMode_TitleOnLeft.
virtual void retranslateInternalButtons()=0
Retranslate internal buttons that are not accessible from the outside:
virtual void setDialogIcon(const std::string &iconName)=0
Set the dialog icon.
void protectNextButton(bool protect)
Protect the wizard's "Next" button against disabling.
virtual void deleteSteps()=0
Delete all steps and step headings from the internal lists.
virtual void showReleaseNotesButton(const std::string &label, const std::string &id)=0
Show a "Release Notes" button above the "Help" button in the steps panel with the specified label tha...
A wizard is a more complex frame typically used for multi-step workflows:
virtual YPropertyValue getProperty(const std::string &propertyName)
Get a property.
virtual void hideReleaseNotesButton()=0
Hide an existing "Release Notes" button.
virtual void addMenuSeparator(const std::string &parentMenuID)=0
Add a menu separator to a menu.
virtual void setCurrentStep(const std::string &id)=0
Set the current step.
virtual void addMenu(const std::string &text, const std::string &id)=0
Add a menu to the menu bar.
virtual void setHelpText(const std::string &helpText)=0
Set the help text.
virtual std::string currentTreeSelection()=0
Returns the current tree selection or an empty string if nothing is selected or there is no tree...
virtual YPushButton * backButton() const =0
Return the wizard buttons or 0 if there is no such button.
virtual void selectTreeItem(const std::string &id)=0
Select the tree item with the specified ID, if such an item exists.
virtual const char * widgetClass() const
Returns a descriptive name of this widget class for logging, debugging etc.