kiway_player.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2017-2023 KiCad Developers, see change_log.txt for contributors.
 * Copyright (C) 2023 CERN (www.cern.ch)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef KIWAY_PLAYER_H_
#define KIWAY_PLAYER_H_
 
#include <wx/frame.h>
 
#include <vector>
#include <kiway_holder.h>
#include <eda_base_frame.h>
 
class KIWAY;
class PROJECT;
struct KIFACE;
class KIFACE_BASE;
class TOOL_MANAGER;
class KIWAY_EXPRESS;
 
#define WX_EVENT_LOOP wxGUIEventLoop
class WX_EVENT_LOOP;
 
class wxSocketServer;
class wxSocketBase;
class wxSocketEvent;
class wxCmdLineParser;
 
 
#ifdef SWIG
class KIWAY_PLAYER : public wxFrame, public KIWAY_HOLDER
#else
class KIWAY_PLAYER : public EDA_BASE_FRAME
#endif
{
public:
 KIWAY_PLAYER( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
 const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
 long aStyle, const wxString& aFrameName, const EDA_IU_SCALE& aIuScale );
 
 ~KIWAY_PLAYER() throw();
 
 // For the aCtl argument of OpenProjectFiles()
#define KICTL_NONKICAD_ONLY (1<<0) 
#define KICTL_KICAD_ONLY (1<<1) 
#define KICTL_CREATE (1<<2) 
#define KICTL_IMPORT_LIB (1<<3) 
#define KICTL_REVERT (1<<4) 
 
 virtual bool OpenProjectFiles( const std::vector<wxString>& aFileList, int aCtl = 0 )
 {
 // overload me for your wxFrame type.
 
 // Any overload should probably do this also:
 // Prj().MaybeLoadProjectSettings();
 
 // Then update the window title.
 
 return false;
 }
 
 
 virtual bool ShowModal( wxString* aResult = nullptr,
 wxWindow* aResultantFocusWindow = nullptr );
 
 virtual void KiwayMailIn( KIWAY_EXPRESS& aEvent );
 
 bool Destroy() override;
 
 bool IsModal() const override { return m_modal; }
 void SetModal( bool aIsModal ) { m_modal = aIsModal; }
 
 bool IsDismissed();
 
 void DismissModal( bool aRetVal, const wxString& aResult = wxEmptyString );
 
 /* interprocess communication */
 void CreateServer( int service, bool local = true );
 void OnSockRequest( wxSocketEvent& evt );
 void OnSockRequestServer( wxSocketEvent& evt );
 
 virtual void ExecuteRemoteCommand( const char* cmdline ){}
 
protected:
 
 void kiway_express( KIWAY_EXPRESS& aEvent );
 
 void language_change( wxCommandEvent& event );
 
 // variables for modal behavior support, only used by a few derivatives.
 bool m_modal; // true if frame is intended to be modal, not modeless
 
 WX_EVENT_LOOP* m_modal_loop;
 wxWindow* m_modal_resultant_parent; // the window caller in modal mode
 wxString m_modal_string;
 bool m_modal_ret_val; // true if a selection was made
 
 wxSocketServer* m_socketServer;
 std::vector<wxSocketBase*> m_sockets; 
 
#ifndef SWIG
 DECLARE_EVENT_TABLE()
#endif
};
 
 
// pseudo code for OpenProjectFiles
#if 0
 
bool OpenProjectFiles( const std::vector<wxString>& aFileList, int aCtl = 0 )
{
 if( aFileList.size() != 1 )
 {
 complain via UI.
 return false
 }
 
 assert( aFileList[0] is absolute ) // bug in single_top.cpp or project manager.
 
 if( !Pgm().LockFile( fullFileName ) )
 {
 DisplayError( this, _( "This file is already open." ) );
 return false;
 }
 
 if current open project files have been modified
 {
 ask if user wants to save them and if yes save.
 }
 
 unload any currently open project files.
 
 Prj().SetProjectFullName( )
 
 if( aFileList[0] does not exist )
 {
 notify user file does not exist and ask if he wants to create it
 if( yes )
 {
 create empty project file(s)
 mark file as modified.
 
 use the default project config file.
 }
 else
 return false
 }
 else
 {
 load aFileList[0]
 
 use the project config file for project given by aFileList[0]s full path.
 }
 
 UpdateFileHistory( g_RootSheet->GetScreen()->GetFileName() );
 
 /* done in ReDraw typically:
 UpdateTitle();
 */
 
 show contents.
}
 
#endif
 
#endif // KIWAY_PLAYER_H_