Code::Blocks Forums

Developer forums (C::B DEVELOPMENT STRICTLY!) => Plugins development => Topic started by: ollydbg on August 30, 2012, 04:13:30 am

Title: wxsmith GUI overview (draw in ascii art)
Post by: ollydbg on August 30, 2012, 04:13:30 am

Code

/*
      +------+--------------------------+
      |      |    +------------------+--+
      |  A   |    |        C         |  |
      |      |    |                  |D |
      +------+    |------------------|  |
      |      |    |        E         |  |
      |  B   |    +------------------+--+
      |      |                          |
      +------+--------------------------+
A: Resource browser tree (wxsResourceTree)
B: Property browser (wxsPropertyGridManager)
C: Item editor (wxsItemEditor)
D: Advanced quick properties panel (wxsAdvQPP)
E: wxsmith widget palette (wxNotebook)

*/

*/

Hope we can have such kind of comments in the code to give the reader a clear and quick understanding. ;)

I'm using this tool to draw this ascii art. It's open source, and its source is on github.
http://www.asciiflow.com/#Draw

Title: Re: wxsmith GUI overview (draw in ascii art)
Post by: stefanos_ on August 30, 2012, 11:13:51 am

Looks nice the way you put it, but I think with real images would be even better; that is, if you could find from other projects similar GUI elements which could be added on wxSmith or existing ones that could get tweaked a bit, that would be really helpful indeed for readers. Of course, your example is still readable so I guess that would be a start.

Title: Re: wxsmith GUI overview (draw in ascii art)
Post by: MortenMacFly on August 30, 2012, 11:17:27 am

Quote from: stefanos_ on August 30, 2012, 11:13:51 am

but I think with real images would be even better;

Its for documentation purposes inside source code files, so I don't think real images are usable... ;)

Quote from: ollydbg on August 30, 2012, 04:13:30 am

Hope we can have such kind of comments in the code to give the reader a clear and quick understanding. ;)

Title: Re: wxsmith GUI overview (draw in ascii art)
Post by: stefanos_ on August 30, 2012, 12:21:31 pm

ah for class documentation for example? that would be interesting, yep! I thought you were talking about user documentation like the official manual.