Scippy

SCIP

Solving Constraint Integer Programs

Macros | Typedefs
type_dialog.h File Reference
Public API of SCIP » Core API » Type Definitions

Detailed Description

type definitions for user interface dialog

Author
Tobias Achterberg

This file defines the interface for dialogs implemented in C.

Definition in file type_dialog.h.

#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"

Go to the source code of this file.

Macros

#define SCIP_DECL_DIALOGCOPY(x)   SCIP_RETCODE x (SCIP* scip, SCIP_DIALOG* dialog)
 
#define SCIP_DECL_DIALOGFREE(x)   SCIP_RETCODE x (SCIP* scip, SCIP_DIALOG* dialog)
 
#define SCIP_DECL_DIALOGDESC(x)   SCIP_RETCODE x (SCIP* scip, SCIP_DIALOG* dialog)
 
#define SCIP_DECL_DIALOGEXEC(x)   SCIP_RETCODE x (SCIP* scip, SCIP_DIALOG* dialog, SCIP_DIALOGHDLR* dialoghdlr, SCIP_DIALOG** nextdialog)
 

Typedefs

typedef struct SCIP_Dialog SCIP_DIALOG
 
typedef struct SCIP_DialogData SCIP_DIALOGDATA
 
typedef struct SCIP_Dialoghdlr SCIP_DIALOGHDLR
 
typedef struct SCIP_Linelist SCIP_LINELIST
 

Macro Definition Documentation

◆ SCIP_DECL_DIALOGCOPY

#define SCIP_DECL_DIALOGCOPY (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_DIALOG* dialog)

copy method for dialog plugins (called when SCIP copies plugins)

input:

  • scip : SCIP main data structure
  • dialog : the dialog itself

Definition at line 53 of file type_dialog.h.

◆ SCIP_DECL_DIALOGFREE

#define SCIP_DECL_DIALOGFREE (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_DIALOG* dialog)

destructor of dialog to free user data (called when the dialog is not captured anymore)

input:

  • scip : SCIP main data structure
  • dialog : the dialog itself

Definition at line 61 of file type_dialog.h.

◆ SCIP_DECL_DIALOGDESC

#define SCIP_DECL_DIALOGDESC (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_DIALOG* dialog)

description output method of dialog

This method should output (usually a single line of) information describing the meaning of the dialog. The method is called, when the help menu of the parent's dialog is displayed. If no description output method is given, the description string of the dialog is displayed instead.

input:

  • scip : SCIP main data structure
  • *dialog : the dialog itself

Definition at line 73 of file type_dialog.h.

◆ SCIP_DECL_DIALOGEXEC

#define SCIP_DECL_DIALOGEXEC (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_DIALOG* dialog, SCIP_DIALOGHDLR* dialoghdlr, SCIP_DIALOG** nextdialog)

execution method of dialog

This method is invoked, if the user selected the dialog's command name in the parent's dialog menu.

input:

  • scip : SCIP main data structure
  • dialoghdlr : dialog handler to call for user interaction
  • dialog : the dialog itself

output:

  • *nextdialog : next dialog to process (or NULL to quit dialog processing)

Definition at line 87 of file type_dialog.h.

Typedef Documentation

◆ SCIP_DIALOG

typedef struct SCIP_Dialog SCIP_DIALOG

user interface dialog

Definition at line 41 of file type_dialog.h.

◆ SCIP_DIALOGDATA

typedef struct SCIP_DialogData SCIP_DIALOGDATA

user defined dialog data

Definition at line 42 of file type_dialog.h.

◆ SCIP_DIALOGHDLR

typedef struct SCIP_Dialoghdlr SCIP_DIALOGHDLR

dialog handler

Definition at line 43 of file type_dialog.h.

◆ SCIP_LINELIST

typedef struct SCIP_Linelist SCIP_LINELIST

linked list of single input lines

Definition at line 44 of file type_dialog.h.