pub_dialog.h File Reference Detailed Descriptionpublic methods for user interface dialog Definition in file pub_dialog.h. #include "scip/def.h" #include "scip/type_retcode.h" #include "scip/type_scip.h" #include "scip/type_dialog.h" Go to the source code of this file. Function Documentation
returns the root dialog of the dialog handler
Definition at line 425 of file dialog.c. References NULL, and SCIP_Dialoghdlr::rootdialog. Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIPaddDialogEntry(), and SCIPgetRootDialog().
clears the input command buffer of the dialog handler
Definition at line 435 of file dialog.c. References SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, and NULL. Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIPdialoghdlrCreate(), SCIPdialoghdlrExec(), SCIPdialoghdlrGetLine(), SCIPdialoghdlrGetWord(), and writeProblem().
returns TRUE iff input command buffer is empty
Definition at line 446 of file dialog.c. References SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, and NULL. Referenced by SCIP_DECL_DIALOGEXEC(), SCIPdialoghdlrGetLine(), and SCIPdialoghdlrGetWord().
returns the next line in the handler's command buffer; if the buffer is empty, displays the given prompt or the current dialog's path and asks the user for further input; the user must not free or modify the returned string
Definition at line 459 of file dialog.c. References SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, FALSE, NULL, readInputLine(), SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdialogGetPath(), SCIPdialoghdlrAddHistory(), SCIPdialoghdlrClearBuffer(), SCIPdialoghdlrIsBufferEmpty(), SCIPsnprintf(), and TRUE. Referenced by SCIP_DECL_DIALOGEXEC().
returns the next word in the handler's command buffer; if the buffer is empty, displays the given prompt or the current dialog's path and asks the user for further input; the user must not free or modify the returned string
Definition at line 536 of file dialog.c. References SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, FALSE, NULL, readInputLine(), SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdebugMessage, SCIPdialogGetPath(), SCIPdialoghdlrAddHistory(), SCIPdialoghdlrClearBuffer(), SCIPdialoghdlrIsBufferEmpty(), and SCIPsnprintf(). Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), and writeProblem().
adds a single line of input to the dialog handler which is treated as if the user entered the command line
Definition at line 687 of file dialog.c. References BMSallocMemory, BMSduplicateMemoryArray, SCIP_Linelist::inputline, SCIP_Dialoghdlr::inputlistptr, SCIP_Linelist::nextline, NULL, SCIP_ALLOC, and SCIP_OKAY. Referenced by SCIPaddDialogInputLine().
adds a command to the command history of the dialog handler; if a dialog is given, the command is preceeded by the dialog's command path; if no command is given, only the path to the dialog is added to the command history
Definition at line 711 of file dialog.c. References addHistory(), getHistoryLength(), SCIP_Dialog::name, SCIP_Dialoghdlr::nprotectedhistelems, NULL, SCIP_Dialog::parent, removeHistory(), SCIP_Dialoghdlr::rootdialog, SCIP_Bool, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPescapeString(), and SCIPsnprintf(). Referenced by SCIP_DECL_DIALOGEXEC(), SCIPaddDialogHistoryLine(), SCIPdialoghdlrGetLine(), SCIPdialoghdlrGetWord(), and writeProblem().
returns TRUE iff a dialog entry matching exactly the given name is existing in the given dialog
Definition at line 970 of file dialog.c. References FALSE, NULL, SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), SCIPdialogGetSubdialogs(), and TRUE. Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPdialogAddEntry(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefault(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
searches the dialog for entries corresponding to the given name; If a complete match is found, the entry is returned as "subdialog" and the return value is 1. If no dialog entry completely matches the given "entryname", the number of entries with names beginning with "entryname" is returned. If this number is 1, the single match is returned as "subdialog". Otherwise, "subdialog" is set to NULL.
Definition at line 1003 of file dialog.c. References NULL, SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), and SCIPdialogGetSubdialogs(). Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), dialogExecMenu(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefault(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().
displays the dialog's menu
Definition at line 1047 of file dialog.c. References SCIP_Dialog::nsubdialogs, NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogDisplayMenuEntry(), SCIPdialogIsSubmenu(), SCIPdialogMessage(), and SCIP_Dialog::subdialogs. Referenced by SCIP_DECL_DIALOGEXEC().
displays the entry for the dialog in it's parent's menu
Definition at line 1081 of file dialog.c. References SCIP_Dialog::desc, SCIP_Dialog::issubmenu, SCIP_Dialog::name, NULL, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdialogMessage(), and SCIPsnprintf(). Referenced by SCIPdialogDisplayCompletions(), and SCIPdialogDisplayMenu().
displays all dialog entries with names starting with the given "entryname"
Definition at line 1115 of file dialog.c. References NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogDisplayMenuEntry(), SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), and SCIPdialogGetSubdialogs(). Referenced by dialogExecMenu().
gets the name of the current path in the dialog tree, separated by the given character
Definition at line 1146 of file dialog.c. References SCIP_Dialog::name, NULL, SCIP_Dialog::parent, SCIP_MAXSTRLEN, and SCIPsnprintf(). Referenced by SCIPdialoghdlrGetLine(), and SCIPdialoghdlrGetWord().
gets the command name of the dialog
Definition at line 1170 of file dialog.c. References SCIP_Dialog::name, and NULL. Referenced by SCIP_DECL_SORTPTRCOMP(), SCIPdialogAddEntry(), SCIPdialogCopyInclude(), SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
gets the description of the dialog
Definition at line 1180 of file dialog.c. References SCIP_Dialog::desc, and NULL.
returns whether the dialog is a sub menu
Definition at line 1190 of file dialog.c. References SCIP_Dialog::issubmenu, and NULL. Referenced by SCIPdialogDisplayMenu().
gets the parent dialog of the given dialog
Definition at line 1200 of file dialog.c. References NULL, and SCIP_Dialog::parent. Referenced by dialogExecMenu(), and SCIP_DECL_DIALOGEXEC().
gets the array of sub-dialogs associated with the given dialog
Definition at line 1210 of file dialog.c. References NULL, and SCIP_Dialog::subdialogs. Referenced by SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
gets the number of sub-dialogs associated with the given dialog
Definition at line 1220 of file dialog.c. References SCIP_Dialog::nsubdialogs, and NULL. Referenced by SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
gets the user defined data associated with the given dialog
Definition at line 1230 of file dialog.c. References SCIP_Dialog::dialogdata, and NULL. Referenced by SCIP_DECL_DIALOGCOPY(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), and SCIP_DECL_DIALOGFREE().
sets user data of dialog; user has to free old data in advance!
Definition at line 1240 of file dialog.c. References SCIP_Dialog::dialogdata, and NULL. Referenced by SCIP_DECL_DIALOGFREE().
writes command history to specified filename
Definition at line 1251 of file dialog.c. References writeHistory(). Referenced by SCIP_DECL_DIALOGEXEC(). |