WxSmith tutorial: Adding advanced properties into items - Revision history

Byo: /* WARNING: NOT YET FINISHED */

2007-10-14T19:30:31Z

WARNING: NOT YET FINISHED

← Older revision		Revision as of 19:30, 14 October 2007
Line 3:		Line 3:
	[[Category:wxSmith extensions]]		[[Category:wxSmith extensions]]

	~~== WARNING: NOT YET FINISHED ==~~

	== Preface ==		== Preface ==

Byo at 19:23, 14 October 2007

2007-10-14T19:23:40Z

← Older revision		Revision as of 19:23, 14 October 2007
Line 1:		Line 1:
			[[Category:Code::Blocks Documentation]]
			[[Category:Developer Documentation]]
			[[Category:wxSmith extensions]]

	== WARNING: NOT YET FINISHED ==		== WARNING: NOT YET FINISHED ==

Line 24:		Line 28:
	void OnAddExtraProperties(wxsPropertyGridManager* Grid);		void OnAddExtraProperties(wxsPropertyGridManager* Grid);

	Inside this class we can freely operate on given <tt>wxsPropertyGridManager</tt> (see [http://wxpropgrid.sourceforge.net/ wxPropertyGrid site] to learn more on how to operate on this class), but the operations should be limited to ~~ading~~ properties (it may be risky to delete or change existing ones).		Inside this class we can freely operate on given <tt>wxsPropertyGridManager</tt> (see [http://wxpropgrid.sourceforge.net/ wxPropertyGrid site] to learn more on how to operate on this class), but the operations should be limited to adding properties and responding for property change (it may be risky to delete or change existing ones).

	At the end of custom implementation of this function, we should also call the original function declared inside wxsWidget class:		At the end of custom implementation of this function, we should also call the original function declared inside wxsWidget class:

Byo: /* Updating XML structures */

2007-04-21T09:41:05Z

Updating XML structures

← Older revision		Revision as of 09:41, 21 April 2007
Line 620:		Line 620:

	In few places we used cbC2U which converts char* string into wxString.		In few places we used cbC2U which converts char* string into wxString.


			Now if we test new chart, it stores and restores all data from xml structures (the easiest way to test it is to use undo/redo operations since they internally use xml structures). Now we can continue updating of wxChart item by generating better source code and preview. This will be covered in next tutorial.

Byo: /* Adding dynamically changing properties set */

2007-04-21T09:35:07Z

Adding dynamically changing properties set

← Older revision		Revision as of 09:35, 21 April 2007
Line 228:		Line 228:
	{		{
	// '''(4)		// '''(4)

	// We have to generate new entries		// We have to generate new entries
	for ( int i=OldValue; i<NewValue; i++ )		for ( int i=OldValue; i<NewValue; i++ )
Line 239:		Line 239:
	{		{
	// '''(5)		// '''(5)

	// We have to remove some entries		// We have to remove some entries
	for ( int i=NewValue; i<OldValue; i++ )		for ( int i=NewValue; i<OldValue; i++ )
Line 510:		Line 510:

	In this tutorial we will cover only xml operations. Affecting preview and source code will be described in next tutorial.		In this tutorial we will cover only xml operations. Affecting preview and source code will be described in next tutorial.


	=== Updating XML structures ===		=== Updating XML structures ===

Byo: /* Preface */

2007-04-21T09:31:58Z

Preface

← Older revision		Revision as of 09:31, 21 April 2007
Line 3:		Line 3:
	== Preface ==		== Preface ==

	In previous tutorial we learned how to add some basic properties into our custom item. In this tutorial we will learn how to create fully customizable properties by operating directly on wxProperytGrid and xml structures. Let's take a look how wxSmith deals with ~~them~~:		In previous tutorial we learned how to add some basic properties into our custom item. In this tutorial we will learn how to create fully customizable properties by operating directly on wxProperytGrid and xml structures. Note that we will use [http://wxpropgrid.sourceforge.net/ wxPropertyGrid] and [http://www.grinninglizard.com/tinyxml/ TinyXml] libraries here so I recommend you get familliar with them first.

			Let's take a look how wxSmith deals with fully customizable properties:

	== Fully customizable properties ==		== Fully customizable properties ==

Byo: /* Updating XML structures */

2007-04-20T22:07:04Z

Updating XML structures

← Older revision		Revision as of 22:07, 20 April 2007
Line 517:		Line 517:
	First problem we will solve is to store data into xml. Each chart point set will be stored inside <chartpointset> node and each point of this set will be stored inside <point> node which will be added as child of <chartpointset>. Some example structure may look like this:		First problem we will solve is to store data into xml. Each chart point set will be stored inside <chartpointset> node and each point of this set will be stored inside <point> node which will be added as child of <chartpointset>. Some example structure may look like this:

	<object class="wxChartCtrl">		<object class="wxChartCtrl" name="ID_CHART1" variable="Chart1" member="no">
	<chartpointset>		<chartpointset name="" type="pie">
	</~~cartpointset~~>		<point name="Point 1" x="5.000000" y="6.000000" />
	</object>		<point name="Point 2" x="7.000000" y="8.000000" />
			<point name="Point 3c" x="9.000000" y="10.000000" />
			</chartpointset>
			<chartpointset name="" type="line3d">
			<point name="Point 1" x="0.000000" y="0.000000" />
			<point name="Point 2" x="10.000000" y="10.000000" />
			</chartpointset>
			</object>

	So let's write function which will store data into xml:		So let's write function which will store data into xml:

Byo: /* Adding dynamically changing properties set */

2007-04-20T22:02:19Z

Adding dynamically changing properties set

← Older revision		Revision as of 22:02, 20 April 2007
Line 508:		Line 508:

	In this tutorial we will cover only xml operations. Affecting preview and source code will be described in next tutorial.		In this tutorial we will cover only xml operations. Affecting preview and source code will be described in next tutorial.


			=== Updating XML structures ===


			wxSmith uses XML strucures to store data of resource in many places. Most obvious one is XRC file, another example is WXS file and the third, hidden one is that wxSmith uses XML format to store entries in undo/redo buffers. So without routines responsible for storing and reading our custom property into xml, we don't have any of those features.

			First problem we will solve is to store data into xml. Each chart point set will be stored inside <chartpointset> node and each point of this set will be stored inside <point> node which will be added as child of <chartpointset>. Some example structure may look like this:

			<object class="wxChartCtrl">
			<chartpointset>
			</cartpointset>
			</object>

			So let's write function which will store data into xml:

			bool wxsChart::OnXmlWrite(TiXmlElement* Element,bool IsXRC,bool IsExtra)
			{
			for ( size_t i=0; i<m_ChartPointsDesc.Count(); i++ )
			{
			ChartPointsDesc* Desc = m_ChartPointsDesc[i];
			TiXmlElement* DescElem = Element->InsertEndChild(TiXmlElement("chartpointset"))
			->ToElement();

			DescElem->SetAttribute("name",cbU2C(Desc->Name));
			switch ( Desc->Type )
			{
			case Bar: DescElem->SetAttribute("type","bar"); break;
			case Bar3D: DescElem->SetAttribute("type","bar3d"); break;
			case Pie: DescElem->SetAttribute("type","pie"); break;
			case Pie3D: DescElem->SetAttribute("type","pie3d"); break;
			case Points: DescElem->SetAttribute("type","points"); break;
			case Points3D: DescElem->SetAttribute("type","points3d"); break;
			case Line: DescElem->SetAttribute("type","line"); break;
			case Line3D: DescElem->SetAttribute("type","line3d"); break;
			case Area: DescElem->SetAttribute("type","area"); break;
			case Area3D: DescElem->SetAttribute("type","area3d"); break;
			}

			for ( size_t j=0; j<Desc->Points.Count(); j++ )
			{
			PointDesc* PDesc = Desc->Points[j];
			TiXmlElement* PointElem = DescElem->InsertEndChild(TiXmlElement("point"))
			->ToElement();
			PointElem->SetAttribute("name",cbU2C(PDesc->Name));
			PointElem->SetDoubleAttribute("x",PDesc->X);
			PointElem->SetDoubleAttribute("y",PDesc->Y);
			}
			}

			return wxsWidget::OnXmlWrite(Element,IsXRC,IsExtra);
			}

			In this function we iterate through all sets and store xml data for it. Note that TinyXml can not operate on wxStirng nor unicode characters directly. So we have to use <tt>cbU2C</tt> macro provided by Code::Blocks which will convert unicode string into standard char* (maybe it's not best solution since it should always use wxConvUTF8 because that's default encoding in xml files used by wxSmith).

			Now let's write reading function. It's very simillar to writing function:

			bool wxsChart::OnXmlRead(TiXmlElement* Element,bool IsXRC,bool IsExtra)
			{
			for ( size_t i=0; i<m_ChartPointsDesc.Count(); i++ )
			{
			delete m_ChartPointsDesc[i];
			}
			m_ChartPointsDesc.Clear();

			for ( TiXmlElement* DescElem = Element->FirstChildElement("chartpointset");
			DescElem;
			DescElem = DescElem->NextSiblingElement("chartpointset") )
			{
			ChartPointsDesc* Desc = new ChartPointsDesc;
			Desc->Name = cbC2U(DescElem->Attribute("name"));
			wxString Type = cbC2U(DescElem->Attribute("type"));

			if ( Type == _T("bar") ) Desc->Type = Bar; else
			if ( Type == _T("bar3d") ) Desc->Type = Bar3D; else
			if ( Type == _T("pie") ) Desc->Type = Pie; else
			if ( Type == _T("pie3d") ) Desc->Type = Pie3D; else
			if ( Type == _T("points") ) Desc->Type = Points; else
			if ( Type == _T("points3d") ) Desc->Type = Points3D; else
			if ( Type == _T("line") ) Desc->Type = Line; else
			if ( Type == _T("line3d") ) Desc->Type = Line3D; else
			if ( Type == _T("area") ) Desc->Type = Area; else
			if ( Type == _T("area3d") ) Desc->Type = Area3D; else
			Desc->Type = Bar;

			for ( TiXmlElement* PointElem = DescElem->FirstChildElement("point");
			PointElem;
			PointElem = PointElem->NextSiblingElement("point") )
			{
			PointDesc* Point = new PointDesc;
			Point->Name = cbC2U(PointElem->Attribute("name"));
			(PointElem->QueryDoubleAttribute("x",&Point->X) == TIXML_SUCCESS) \|\| (Point->X = 0.0);
			(PointElem->QueryDoubleAttribute("y",&Point->Y) == TIXML_SUCCESS) \|\| (Point->Y = 0.0);

			Desc->Points.Add(Point);
			}

			m_ChartPointsDesc.Add(Desc);
			}

			return wxsWidget::OnXmlRead(Element,IsXRC,IsExtra);
			}

			In few places we used cbC2U which converts char* string into wxString.

Byo: /* Adding dynamically changing properties set */

2007-04-20T21:25:19Z

Adding dynamically changing properties set

Show changes

Byo: /* Fully customizable properties */

2007-04-20T20:31:05Z

Fully customizable properties

← Older revision		Revision as of 20:31, 20 April 2007
Line 7:		Line 7:
	== Fully customizable properties ==		== Fully customizable properties ==

	To create fully costomizable property we ~~hve~~ to handle few operations done on it:		To create fully costomizable property we have to handle few operations done on it:

	* Adding property to property grid		* Adding property to property grid
Line 14:		Line 14:
	* Writing data to XML (XRC) structures		* Writing data to XML (XRC) structures

	Each of these operations is done inside one virtual function of class which adds item into wxSmith (like wxsChart in our chart example). Overriding it and giving custom implementation allows to freely operate on properties.		Each of these operations is done inside one virtual function of class which adds item into wxSmith (like wxsChart in our chart example). Overriding it and giving custom implementation allows us to freely operate on properties.

	=== Adding custom property to property grid ===		=== Adding custom property to property grid ===
Line 101:		Line 101:

	The meaning of arguments is same as in case of reading data. The only difference is that we write data here instead of reading it.		The meaning of arguments is same as in case of reading data. The only difference is that we write data here instead of reading it.


	== Adding custom property into wxChart ==		== Adding custom property into wxChart ==

Byo: /* Preface */

2007-04-20T20:29:07Z

Preface

← Older revision		Revision as of 20:29, 20 April 2007
Line 3:		Line 3:
	== Preface ==		== Preface ==

	In previous tutorial we learned how to add some basic properties into our custom item. In this tutorial we will learn how to create fully customizable properties by operating directly on wxProperytGrid and xml structures. Let's take a look how wxSmith ~~deal~~ with them:		In previous tutorial we learned how to add some basic properties into our custom item. In this tutorial we will learn how to create fully customizable properties by operating directly on wxProperytGrid and xml structures. Let's take a look how wxSmith deals with them:

	== Fully customizable properties ==		== Fully customizable properties ==