AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
52130e43ab
wxWidgets/docs/contributing/how-to-add-new-xrc-handler.md
Vadim Zeitlin e96b28181c Convert contributors documentation to markdown. 
The conversion is very superficial and there are probably many problems in the
Markdown rendering, but this is the first step towards making these documents
more readable when viewing them online.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76690 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-06-11 21:14:09 +00:00

1.5 KiB
Raw Blame History

How to add a new XRC handler

  1. Purpose

This note describes what needs to be done to add a new XRC handler, i.e. add support for loading the objects of some class wxFoo from XRC.

  1. Implement the handler

By convention, the XRC handler for a class wxFoo declared in wx/foo.h is called wxFooXmlHandler and is declared in the file wx/xrc/xh_foo.h (this last rule wasn't always respected in the past, however it's not a reason to not respect it in the future). The steps for adding a new handler are:

  • Add handler declaration in include/wx/xrc/xh_foo.h, it will usually be the same as in the other files so you can get inspiration for your brand new handler from e.g. wx/xrc/xh_srchctrl.h. Notice the use of wxUSE_FOO if wxFoo is guarded by this symbol.

  • Add implementation in src/xrc/xh_foo.cpp: again, it will be almost always very similar to the existing controls. You will need to add support for the control-specific styles.

  1. Update the other files

There are a few other files to update to make wxWidgets aware of the new handler:

  • Add the new files created above to build/bakefiles/files.bkl: search for "xh_srchctrl" to see where you need to add them

  • Add #include "wx/xrc/xh_foo.h" to wx/xrc/xh_all.h.

  • Register the new handler in wxXmlResource::InitAllHandlers() in src/xrc/xmlrsall.cpp

  1. Update the sample

Demonstrate that the new handler works by adding a control using it to samples/xrc/rc/controls.xrc.