G4UIWin32 Class Reference

#include <G4UIWin32.hh>

Inheritance diagram for G4UIWin32:

Public Member Functions
	G4UIWin32 ()
	~G4UIWin32 () override
G4UIsession *	SessionStart () override
void	AddMenu (const char *, const char *) override
void	AddButton (const char *, const char *, const char *) override
void	Prompt (const G4String &)
void	SessionTerminate ()
void	PauseSessionStart (const G4String &) override
G4int	ReceiveG4debug (const G4String &) override
G4int	ReceiveG4cout (const G4String &) override
G4int	ReceiveG4cerr (const G4String &) override
G4String	GetCommand (G4int)
Public Member Functions inherited from G4VBasicShell
	G4VBasicShell ()
	~G4VBasicShell () override
Public Member Functions inherited from G4UIsession
	G4UIsession ()
	G4UIsession (G4int iBatch)
	~G4UIsession () override
G4int	GetLastReturnCode () const
Public Member Functions inherited from G4coutDestination
	G4coutDestination ()=default
virtual	~G4coutDestination ()=default
void	AddDebugTransformer (const Transformer &t)
void	AddDebugTransformer (Transformer &&t)
void	AddCoutTransformer (const Transformer &t)
void	AddCoutTransformer (Transformer &&t)
void	AddCerrTransformer (const Transformer &t)
void	AddCerrTransformer (Transformer &&t)
virtual void	ResetTransformers ()
G4int	ReceiveG4debug_ (const G4String &msg)
G4int	ReceiveG4cout_ (const G4String &msg)
G4int	ReceiveG4cerr_ (const G4String &msg)
Public Member Functions inherited from G4VInteractiveSession
	G4VInteractiveSession ()
virtual	~G4VInteractiveSession ()
virtual void	AddIcon (const char *, const char *, const char *, const char *)
virtual void	DefaultIcons (bool)
virtual void	SetOutputStyle (const char *, const char *)
virtual void	NativeMenu (bool)
virtual void	ClearMenu ()
virtual void	UpdateSceneTree (const G4SceneTreeItem &)
void	AddInteractor (G4String, G4Interactor)
G4Interactor	GetInteractor (G4String)
const std::map< G4String, OutputStyle > &	GetOutputStyles () const

Additional Inherited Members
Public Types inherited from G4coutDestination
using	Transformer = std::function<G4bool(G4String&)>
Static Public Member Functions inherited from G4UIsession
static G4int	InSession ()
Protected Member Functions inherited from G4VBasicShell
G4String	ModifyToFullPathCommand (const char *aCommandLine) const
G4String	GetCurrentWorkingDirectory () const
G4bool	ChangeDirectory (const char *newDir)
G4UIcommandTree *	FindDirectory (const char *dirName) const
G4UIcommand *	FindCommand (const char *commandName) const
G4String	Complete (const G4String &)
G4String	FindMatchingPath (G4UIcommandTree *, const G4String &)
virtual void	ExecuteCommand (const G4String &)
void	ApplyShellCommand (const G4String &, G4bool &, G4bool &)
void	ShowCurrent (const G4String &) const
void	ChangeDirectoryCommand (const G4String &)
void	ListDirectory (const G4String &) const
void	TerminalHelp (const G4String &)
Protected Member Functions inherited from G4VInteractiveSession
void	SetStyleUtility (const G4String &destination, const G4String &style)
Protected Attributes inherited from G4UIsession
G4int	ifBatch = 0
G4int	lastRC = 0
Protected Attributes inherited from G4coutDestination
std::vector< Transformer >	transformersDebug
std::vector< Transformer >	transformersCout
std::vector< Transformer >	transformersCerr
Protected Attributes inherited from G4VInteractiveSession
std::map< G4String, OutputStyle >	fOutputStyles
Static Protected Attributes inherited from G4UIsession
static G4ICOMS_DLL G4int	inSession = 0
Static Protected Attributes inherited from G4coutDestination
static G4MTGLOB_DLL G4coutDestination *	masterG4coutDestination = nullptr

Detailed Description

Definition at line 91 of file G4UIWin32.hh.

Constructor & Destructor Documentation

G4UIWin32()

G4UIWin32::G4UIWin32

(

)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Definition at line 62 of file G4UIWin32.cc.

  : fHWndMainWindow(nullptr),
    fHWndEditor(nullptr),
    fHWndToolBar(nullptr),
    fHWndComboBox(nullptr),
    fHWndComboEditor(nullptr),
    fHWndHelpTree(nullptr),
    fHWndStatus(nullptr),
    menuBar(nullptr),
    fHelp(false),
    fHelpChoice(0),
    fHistoryPos(-1)
{
  G4UImanager* UI = G4UImanager::GetUIpointer();
  if (UI != nullptr) {
    UI->SetSession(this);
    UI->SetG4UIWindow(this);
  }
 
  // Ensure that the common control DLL is loaded
  INITCOMMONCONTROLSEX commCtrls;
  commCtrls.dwSize = sizeof(INITCOMMONCONTROLSEX);
  commCtrls.dwICC = ICC_BAR_CLASSES | ICC_LISTVIEW_CLASSES;
  // this loads list-view and toolbar classes.
  InitCommonControlsEx(&commCtrls);
 
  interactorManager = G4Win32::getInstance();
 
  static G4bool Done = false;
  if (! Done) {
    WNDCLASS wc;
    wc.style = 0;
    wc.lpfnWndProc = (WNDPROC)G4UIWin32::MainWindowProc;
    wc.cbClsExtra = 0;
    wc.cbWndExtra = 0;
    wc.hInstance = ::GetModuleHandle(nullptr);
    wc.hIcon = LoadIcon(nullptr, IDI_APPLICATION);
    wc.hCursor = LoadCursor(nullptr, IDC_ARROW);
    wc.hbrBackground = (HBRUSH)(COLOR_WINDOW + 1);
    wc.lpszMenuName = (PTSTR)mainClassName;
    wc.lpszClassName = (PTSTR)mainClassName;
 
    if (! RegisterClass(&wc)) {
      MessageBoxA(nullptr, "G4UIWin32: Win32 window registration failed!", "Error!",
        MB_ICONEXCLAMATION | MB_OK);
      G4cout << "G4UIWin32: Win32 window registration failed!" << G4endl;
      return;
    }
 
    Done = true;
  }
 
  menuBar = CreateMenu();
 
  // Add some initial options to the menu
  HMENU hMenu = CreatePopupMenu();
  AppendMenuA(menuBar, MF_POPUP, (UINT_PTR)hMenu, "&Geant4");
  AddInteractor("Geant4", (G4Interactor)hMenu);
 
  AppendMenuA(hMenu, MF_STRING, ID_OPEN_MACRO, "&Open macro...");
  AppendMenuA(hMenu, MF_STRING, ID_SAVE_VIEWER_STATE, "&Save viewer state...");
  AppendMenuA(hMenu, MF_SEPARATOR, -1, "");
  AppendMenuA(hMenu, MF_STRING, ID_RUN_BEAMON, "&Beam On");
  AppendMenuA(hMenu, MF_SEPARATOR, -1, "");
  AppendMenuA(hMenu, MF_STRING, ID_EXIT_APP, "E&xit");
 
  hMenu = CreatePopupMenu();
  AppendMenuA(menuBar, MF_POPUP, (UINT_PTR)hMenu, "&View");
  AddInteractor("View", (G4Interactor)hMenu);
 
  AppendMenuA(hMenu, MF_STRING, ID_VIEW_SOLID, "S&olid");
  AppendMenuA(hMenu, MF_STRING, ID_VIEW_WIREFRAME, "&Wireframe");
  AppendMenuA(hMenu, MF_SEPARATOR, -1, "");
  AppendMenuA(hMenu, MF_STRING, ID_PROJ_ORTHOGRAPHIC, "&Orthographic");
  AppendMenuA(hMenu, MF_STRING, ID_PROJ_PERSPECTIVE, "P&erspective");
  AppendMenuA(hMenu, MF_SEPARATOR, -1, "");
  AppendMenuA(hMenu, MF_STRING, ID_ORIENTATION_XY, "&X-Y Plane");
  AppendMenuA(hMenu, MF_STRING, ID_ORIENTATION_XZ, "X-&Z Plane");
  AppendMenuA(hMenu, MF_STRING, ID_ORIENTATION_YZ, "&Y-Z Plane");
  AppendMenuA(hMenu, MF_STRING, ID_ORIENTATION_OBLIQUE, "&Oblique");
 
  hMenu = CreatePopupMenu();
  AppendMenuA(menuBar, MF_POPUP, (UINT_PTR)hMenu, "&Zoom");
  AddInteractor("Zoom", (G4Interactor)hMenu);
 
  AppendMenuA(hMenu, MF_STRING, ID_ZOOM_IN, "Zoom &In");
  AppendMenuA(hMenu, MF_STRING, ID_ZOOM_OUT, "Zoom &Out");
 
  tmpSession = this;
  char winName[] = "Geant4";
  fHWndMainWindow = ::CreateWindowEx(WS_EX_CLIENTEDGE, (PTSTR)mainClassName, (PTSTR)winName,
    WS_OVERLAPPEDWINDOW | WS_CLIPCHILDREN, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT,
    CW_USEDEFAULT, nullptr, menuBar, ::GetModuleHandle(nullptr), nullptr);
 
  if (fHWndMainWindow == nullptr) {
    MessageBoxA(nullptr, "Window Creation Failed!", "Error!", MB_ICONEXCLAMATION | MB_OK);
    return;
  }
  tmpSession = nullptr;
  ::SetWindowLongPtr(fHWndMainWindow, GWLP_USERDATA, (LONG_PTR)this);
 
  ::SetForegroundWindow(fHWndMainWindow);
  ::ShowWindow(fHWndMainWindow, SW_SHOWDEFAULT);
  ::UpdateWindow(fHWndMainWindow);
 
  if (UI != nullptr) UI->SetCoutDestination(this);
 
  // TODO: Manage multithreaded output
  // #ifdef G4MULTITHREADED
  // explicitly request that cout/cerr messages from threads are ALSO propagated to the master.
  // masterG4coutDestination = this;
  // #endif
}

~G4UIWin32()

G4UIWin32::~G4UIWin32 ( )

override

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Definition at line 180 of file G4UIWin32.cc.

{
  G4UImanager* UI = G4UImanager::GetUIpointer();
  if (UI != nullptr) {
    UI->SetSession(nullptr);
    UI->SetG4UIWindow(nullptr);
    UI->SetCoutDestination(nullptr);
  }
 
  // TODO: Manage multithreaded output
  // #ifdef G4MULTITHREADED
  // masterG4coutDestination = 0; // set to cout when UI is deleted
  // #endif
 
  if (fHWndStatus != nullptr) ::SetWindowLongPtr(fHWndStatus, GWLP_USERDATA, LONG(NULL));
  if (fHWndHelpTree != nullptr) ::SetWindowLongPtr(fHWndHelpTree, GWLP_USERDATA, LONG(NULL));
  if (fHWndComboBox != nullptr) ::SetWindowLongPtr(fHWndComboBox, GWLP_USERDATA, LONG(NULL));
  if (fHWndToolBar != nullptr) ::SetWindowLongPtr(fHWndToolBar, GWLP_USERDATA, LONG(NULL));
  if (fHWndEditor != nullptr) ::SetWindowLongPtr(fHWndEditor, GWLP_USERDATA, LONG(NULL));
  if (fHWndMainWindow != nullptr) {
    ::SetWindowLongPtr(fHWndMainWindow, GWLP_USERDATA, LONG(NULL));
    ::DestroyWindow(fHWndMainWindow);
  }
}

Member Function Documentation

AddButton()

void G4UIWin32::AddButton ( const char * a_menu, const char * a_label, const char * a_command )

overridevirtual

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Reimplemented from G4VInteractiveSession.

Definition at line 374 of file G4UIWin32.cc.

{
  if ((a_menu != nullptr) && (a_label != nullptr) && (a_command != nullptr)) {
    HMENU hMenu = (HMENU)GetInteractor(a_menu);
    actionIdentifier++;
    commands[actionIdentifier] = a_command;
    AppendMenuA(hMenu, MF_STRING, actionIdentifier, a_label);
  }
}

AddMenu()

void G4UIWin32::AddMenu ( const char * a_name, const char * a_label )

overridevirtual

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Reimplemented from G4VInteractiveSession.

Definition at line 360 of file G4UIWin32.cc.

{
  if (a_name != nullptr) {
    HMENU hMenu = CreatePopupMenu();
    AppendMenuA(menuBar, MF_POPUP, (UINT_PTR)hMenu, a_label);
    AddInteractor(a_name, (G4Interactor)hMenu);
    DrawMenuBar(fHWndMainWindow);
  }
}

GetCommand()

G4String G4UIWin32::GetCommand

(

G4int

a_id

)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Definition at line 388 of file G4UIWin32.cc.

{ return commands[a_id]; }

PauseSessionStart()

void G4UIWin32::PauseSessionStart ( const G4String & a_state )

overridevirtual

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Implements G4VBasicShell.

Definition at line 248 of file G4UIWin32.cc.

{
  if (a_state == "G4_pause> ") {
    SecondaryLoop("Pause, type continue to exit this state");
  }
 
  if (a_state == "EndOfEvent") {
    // Picking with feed back in event data Done here !!!
    SecondaryLoop("End of event, type continue to exit this state");
  }
}

Prompt()

void G4UIWin32::Prompt

(

const G4String &

a_prompt

)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Definition at line 236 of file G4UIWin32.cc.

{}

Referenced by SessionStart().

ReceiveG4cerr()

G4int G4UIWin32::ReceiveG4cerr ( const G4String & a_string )

overridevirtual

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Reimplemented from G4UIsession.

Definition at line 312 of file G4UIWin32.cc.

{
  // Geant4 uses UNIX's style for new lines (\n)
  // we must convert them to Windows' style (\r\n)
  G4String str = ConvertNewLines(a_string);
 
  AddText((LPSTR)str.data());
 
  return 0;
}

ReceiveG4cout()

G4int G4UIWin32::ReceiveG4cout ( const G4String & a_string )

overridevirtual

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Reimplemented from G4UIsession.

Definition at line 297 of file G4UIWin32.cc.

{
  // Geant4 uses UNIX's style for new lines (\n)
  // we must convert them to Windows' style (\r\n)
  G4String str = ConvertNewLines(a_string);
 
  AddText((LPSTR)str.data());
 
  return 0;
}

ReceiveG4debug()

G4int G4UIWin32::ReceiveG4debug ( const G4String & a_string )

overridevirtual

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Reimplemented from G4UIsession.

Definition at line 282 of file G4UIWin32.cc.

{
  // Geant4 uses UNIX's style for new lines (\n)
  // we must convert them to Windows' style (\r\n)
  G4String str = ConvertNewLines(a_string);
 
  AddText((LPSTR)str.data());
 
  return 0;
}

SessionStart()

G4UIsession * G4UIWin32::SessionStart ( )

overridevirtual

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Implements G4VBasicShell.

Definition at line 209 of file G4UIWin32.cc.

{
  if (interactorManager != nullptr) {
    Prompt("session");
    exitSession = false;
 
    // TODO: Ensure that the list of commands is updated
    // Load commands into Help Tree View
    InitHelpTreeItems();
 
    interactorManager->DisableSecondaryLoop();
    void* event;
    while ((event = interactorManager->GetEvent()) != nullptr) {
      interactorManager->DispatchEvent(event);
      if (exitSession) break;
    }
    interactorManager->EnableSecondaryLoop();
    return this;
  }
  else
    return this;
}

SessionTerminate()

void G4UIWin32::SessionTerminate

(

)

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Definition at line 242 of file G4UIWin32.cc.

{}

---

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

• G4UIWin32.hh
• G4UIWin32.cc