wxWidgets/samples/config/conftest.cpp
Vadim Zeitlin 3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00

271 lines
8.6 KiB
C++

///////////////////////////////////////////////////////////////////////////////
// Name: conftest.cpp
// Purpose: demo of wxConfig and related classes
// Author: Vadim Zeitlin
// Modified by:
// Created: 03.08.98
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
// declarations
// ============================================================================
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
#include "wx/wxprec.h"
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#ifndef WX_PRECOMP
#include "wx/wx.h"
#endif //precompiled headers
#include "wx/log.h"
#include "wx/config.h"
#ifndef wxHAS_IMAGES_IN_RESOURCES
#include "../sample.xpm"
#endif
// ----------------------------------------------------------------------------
// classes
// ----------------------------------------------------------------------------
class MyApp: public wxApp
{
public:
// implement base class virtuals
virtual bool OnInit();
virtual int OnExit();
};
class MyFrame: public wxFrame
{
public:
MyFrame();
virtual ~MyFrame();
// callbacks
void OnQuit(wxCommandEvent& event);
void OnAbout(wxCommandEvent& event);
void OnDelete(wxCommandEvent& event);
private:
wxTextCtrl *m_text;
wxCheckBox *m_check;
DECLARE_EVENT_TABLE()
};
// ----------------------------------------------------------------------------
// event tables
// ----------------------------------------------------------------------------
BEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_MENU(wxID_EXIT, MyFrame::OnQuit)
EVT_MENU(wxID_ABOUT, MyFrame::OnAbout)
EVT_MENU(wxID_DELETE, MyFrame::OnDelete)
END_EVENT_TABLE()
// ============================================================================
// implementation
// ============================================================================
// ----------------------------------------------------------------------------
// application
// ----------------------------------------------------------------------------
IMPLEMENT_APP(MyApp)
// `Main program' equivalent, creating windows and returning main app frame
bool MyApp::OnInit()
{
if ( !wxApp::OnInit() )
return false;
// we're using wxConfig's "create-on-demand" feature: it will create the
// config object when it's used for the first time. It has a number of
// advantages compared with explicitly creating our wxConfig:
// 1) we don't pay for it if we don't use it
// 2) there is no danger to create it twice
// application and vendor name are used by wxConfig to construct the name
// of the config file/registry key and must be set before the first call
// to Get() if you want to override the default values (the application
// name is the name of the executable and the vendor name is the same)
SetVendorName(wxT("wxWidgets"));
SetAppName(wxT("conftest")); // not needed, it's the default value
wxConfigBase *pConfig = wxConfigBase::Get();
// uncomment this to force writing back of the defaults for all values
// if they're not present in the config - this can give the user an idea
// of all possible settings for this program
pConfig->SetRecordDefaults();
// or you could also write something like this:
// wxFileConfig *pConfig = new wxFileConfig("conftest");
// wxConfigBase::Set(pConfig);
// where you can also specify the file names explicitly if you wish.
// Of course, calling Set() is optional and you only must do it if
// you want to later retrieve this pointer with Get().
// create the main program window
MyFrame *frame = new MyFrame;
frame->Show(true);
// use our config object...
if ( pConfig->Read(wxT("/Controls/Check"), 1l) != 0 ) {
wxMessageBox(wxT("You can disable this message box by unchecking\n")
wxT("the checkbox in the main window (of course, a real\n")
wxT("program would have a checkbox right here but we\n")
wxT("keep it simple)"), wxT("Welcome to wxConfig demo"),
wxICON_INFORMATION | wxOK);
}
return true;
}
int MyApp::OnExit()
{
// clean up: Set() returns the active config object as Get() does, but unlike
// Get() it doesn't try to create one if there is none (definitely not what
// we want here!)
delete wxConfigBase::Set((wxConfigBase *) NULL);
return 0;
}
// ----------------------------------------------------------------------------
// frame
// ----------------------------------------------------------------------------
// main frame ctor
MyFrame::MyFrame()
: wxFrame((wxFrame *) NULL, wxID_ANY, wxT("wxConfig Demo"))
{
SetIcon(wxICON(sample));
// menu
wxMenu *file_menu = new wxMenu;
file_menu->Append(wxID_DELETE, wxT("&Delete"), wxT("Delete config file"));
file_menu->AppendSeparator();
file_menu->Append(wxID_ABOUT, wxT("&About\tF1"), wxT("About this sample"));
file_menu->AppendSeparator();
file_menu->Append(wxID_EXIT, wxT("E&xit\tAlt-X"), wxT("Exit the program"));
wxMenuBar *menu_bar = new wxMenuBar;
menu_bar->Append(file_menu, wxT("&File"));
SetMenuBar(menu_bar);
#if wxUSE_STATUSBAR
CreateStatusBar();
#endif // wxUSE_STATUSBAR
// child controls
wxPanel *panel = new wxPanel(this);
(void)new wxStaticText(panel, wxID_ANY, wxT("These controls remember their values!"),
wxPoint(10, 10), wxSize(300, 20));
m_text = new wxTextCtrl(panel, wxID_ANY, wxT(""), wxPoint(10, 40), wxSize(300, 20));
m_check = new wxCheckBox(panel, wxID_ANY, wxT("show welcome message box at startup"),
wxPoint(10, 70), wxSize(300, 20));
// restore the control's values from the config
// NB: in this program, the config object is already created at this moment
// because we had called Get() from MyApp::OnInit(). However, if you later
// change the code and don't create it before this line, it won't break
// anything - unlike if you manually create wxConfig object with Create()
// or in any other way (then you must be sure to create it before using it!).
wxConfigBase *pConfig = wxConfigBase::Get();
// we could write Read("/Controls/Text") as well, it's just to show SetPath()
pConfig->SetPath(wxT("/Controls"));
m_text->SetValue(pConfig->Read(wxT("Text"), wxT("")));
m_check->SetValue(pConfig->Read(wxT("Check"), 1l) != 0);
// SetPath() understands ".."
pConfig->SetPath(wxT("../MainFrame"));
// restore frame position and size
int x = pConfig->Read(wxT("x"), 50),
y = pConfig->Read(wxT("y"), 50),
w = pConfig->Read(wxT("w"), 350),
h = pConfig->Read(wxT("h"), 200);
Move(x, y);
SetClientSize(w, h);
pConfig->SetPath(wxT("/"));
wxString s;
if ( pConfig->Read(wxT("TestValue"), &s) )
{
wxLogStatus(this, wxT("TestValue from config is '%s'"), s.c_str());
}
else
{
wxLogStatus(this, wxT("TestValue not found in the config"));
}
}
void MyFrame::OnQuit(wxCommandEvent&)
{
Close(true);
}
void MyFrame::OnAbout(wxCommandEvent&)
{
wxMessageBox(wxT("wxConfig demo\n(c) 1998-2001 Vadim Zeitlin"), wxT("About"),
wxICON_INFORMATION | wxOK);
}
void MyFrame::OnDelete(wxCommandEvent&)
{
wxConfigBase *pConfig = wxConfigBase::Get();
if ( pConfig == NULL )
{
wxLogError(wxT("No config to delete!"));
return;
}
if ( pConfig->DeleteAll() )
{
wxLogMessage(wxT("Config file/registry key successfully deleted."));
delete wxConfigBase::Set(NULL);
wxConfigBase::DontCreateOnDemand();
}
else
{
wxLogError(wxT("Deleting config file/registry key failed."));
}
}
MyFrame::~MyFrame()
{
wxConfigBase *pConfig = wxConfigBase::Get();
if ( pConfig == NULL )
return;
// save the control's values to the config
pConfig->Write(wxT("/Controls/Text"), m_text->GetValue());
pConfig->Write(wxT("/Controls/Check"), m_check->GetValue());
// save the frame position
int x, y, w, h;
GetClientSize(&w, &h);
GetPosition(&x, &y);
pConfig->Write(wxT("/MainFrame/x"), (long) x);
pConfig->Write(wxT("/MainFrame/y"), (long) y);
pConfig->Write(wxT("/MainFrame/w"), (long) w);
pConfig->Write(wxT("/MainFrame/h"), (long) h);
pConfig->Write(wxT("/TestValue"), wxT("A test value"));
}