Detailed Description

user interface dialog

Definition at line 45 of file struct_dialog.h.

#include <struct_dialog.h>

Public Member Functions
	SCIP_DECL_DIALOGCOPY ((*dialogcopy))

	SCIP_DECL_DIALOGEXEC ((*dialogexec))

	SCIP_DECL_DIALOGDESC ((*dialogdesc))

	SCIP_DECL_DIALOGFREE ((*dialogfree))

Data Fields
char *	name

char *	desc

SCIP_DIALOG *	parent

SCIP_DIALOG **	subdialogs

SCIP_DIALOGDATA *	dialogdata

int	nsubdialogs

int	subdialogssize

int	nuses

SCIP_Bool	issubmenu

SCIP_Bool	hidden

Member Function Documentation

◆ SCIP_DECL_DIALOGCOPY()

SCIP_Dialog::SCIP_DECL_DIALOGCOPY ( * dialogcopy )

copy method of dialog or NULL if you don't want to copy your plugin into sub-SCIPs

◆ SCIP_DECL_DIALOGEXEC()

SCIP_Dialog::SCIP_DECL_DIALOGEXEC ( * dialogexec )

execution method of dialog

◆ SCIP_DECL_DIALOGDESC()

SCIP_Dialog::SCIP_DECL_DIALOGDESC ( * dialogdesc )

description output method of dialog, or NULL

◆ SCIP_DECL_DIALOGFREE()

SCIP_Dialog::SCIP_DECL_DIALOGFREE ( * dialogfree )

destructor of dialog to free user data, or NULL

Field Documentation

◆ name

char* SCIP_Dialog::name

name of dialog: command name appearing in parent's dialog menu

Definition at line 51 of file struct_dialog.h.

Referenced by SCIPdialogDisplayMenuEntry(), SCIPdialogGetName(), SCIPdialogGetPath(), and SCIPdialoghdlrAddHistory().

◆ desc

char* SCIP_Dialog::desc

description of dialog used if description output method is NULL

Definition at line 52 of file struct_dialog.h.

Referenced by SCIPdialogDisplayMenuEntry(), and SCIPdialogGetDesc().

◆ parent

SCIP_DIALOG* SCIP_Dialog::parent

parent dialog of dialog

Definition at line 53 of file struct_dialog.h.

Referenced by SCIPdialogAddEntry(), SCIPdialogGetParent(), SCIPdialogGetPath(), and SCIPdialoghdlrAddHistory().

◆ subdialogs

SCIP_DIALOG** SCIP_Dialog::subdialogs

sub dialogs of dialog

Definition at line 54 of file struct_dialog.h.

Referenced by ensureSubdialogMem(), SCIPdialogAddEntry(), SCIPdialogDisplayMenu(), and SCIPdialogGetSubdialogs().

◆ dialogdata

SCIP_DIALOGDATA* SCIP_Dialog::dialogdata

user defined dialog data

Definition at line 55 of file struct_dialog.h.

Referenced by SCIPdialogGetData(), and SCIPdialogSetData().

◆ nsubdialogs

int SCIP_Dialog::nsubdialogs

number of sub dialogs

Definition at line 56 of file struct_dialog.h.

Referenced by SCIPdialogAddEntry(), SCIPdialogDisplayMenu(), and SCIPdialogGetNSubdialogs().

◆ subdialogssize

int SCIP_Dialog::subdialogssize

size of subdialogs array

Definition at line 57 of file struct_dialog.h.

Referenced by ensureSubdialogMem().

◆ nuses

int SCIP_Dialog::nuses

number of times, the dialog is used

Definition at line 58 of file struct_dialog.h.

Referenced by SCIPdialogCapture().

◆ issubmenu

SCIP_Bool SCIP_Dialog::issubmenu

is the dialog a submenu?

Definition at line 59 of file struct_dialog.h.

Referenced by SCIPdialogDisplayMenuEntry(), and SCIPdialogIsSubmenu().

◆ hidden

SCIP_Bool SCIP_Dialog::hidden

dialog is hidden in the help list?

Definition at line 60 of file struct_dialog.h.

Referenced by SCIPdialogIsHidden(), and SCIPdialogSetHidden().

SCIP