Window Properties

For help with general CEGUI usage:
- Questions about the usage of CEGUI and its features, if not explained in the documentation.
- Problems with the CMAKE configuration or problems occuring during the build process/compilation.
- Errors or unexpected behaviour.

Moderators: CEGUI MVP, CEGUI Team

daves
Home away from home
Home away from home
Posts: 253
Joined: Thu Feb 02, 2006 20:12

Window Properties

Postby daves » Thu Apr 26, 2007 19:37

I've searched a bit through the documentation and am trying to find the list of all window properties, and a description of the property value (and its viable format).

So for example our code specifies the "Image" property for some windows. My understanding is that this property has a format that looks something like the following:

"set:SETNAME image:IMAGENAME"

I found this by digging around in some of the tutorials, but have not been able to find the single location where all window properties and their values are documented.

Can you please provide a link or two to the documentation that I must be missing.

Thanks in advance.

User avatar
Levia
Quite a regular
Quite a regular
Posts: 83
Joined: Mon May 22, 2006 18:25
Location: Bergen op zoom, The Netherlands
Contact:

Postby Levia » Thu Apr 26, 2007 21:16

For as far as I know, these are not listed somewhere. though, you can have a look at the looknfeel file. The property's are listed per widget there.
Image
Image

User avatar
Dalfy
CEGUI Team (Retired)
Posts: 130
Joined: Tue Oct 11, 2005 16:13
Location: Paris, FRANCE
Contact:

Postby Dalfy » Fri Apr 27, 2007 06:01

The issue with this is that we need to write a tool to dump the supported property for a window/look&feel because some property are created dynamically during the definition of the look&feel. So there is no way to list all property supported by let's say a Window in the API reference just because this is not going to be enough and can vary from one look&feel to another.

User avatar
Levia
Quite a regular
Quite a regular
Posts: 83
Joined: Mon May 22, 2006 18:25
Location: Bergen op zoom, The Netherlands
Contact:

Postby Levia » Fri Apr 27, 2007 06:38

Dynamic as in <Child> entry's? (THat they use other entry's property's aswell?)
Image

Image

User avatar
scriptkid
Home away from home
Home away from home
Posts: 1178
Joined: Wed Jan 12, 2005 12:06
Location: The Hague, The Netherlands
Contact:

Postby scriptkid » Fri Apr 27, 2007 09:30

No, that they have new properties defined within a looknfeel file, next to the hard-codes ones. For example if you look in the Windowslook.looknfeel file, things immediately start at the Button, with the possible different colours per state. Those do not appear in the doxygen api files...

However they are registered to the system when the file gets loaded. If you loop all properties of a window, they do show up:

Code: Select all

PropertySet::Iterator propertyIt = (PropertySet*)window->getIterator();
while (!propertyIt.isAtEnd()) {
print("Property [%s: %s]\n", propertyIt.getCurrentKey()).c_str(),
window->getProperty(propertyIt.getCurrentKey()).c_str());
propertyIt++;
}


And we need something like this, but i am not sure how. A very basis script ran from the commandline?, a popup dialog from within our tools?

HTH :)

User avatar
Levia
Quite a regular
Quite a regular
Posts: 83
Joined: Mon May 22, 2006 18:25
Location: Bergen op zoom, The Netherlands
Contact:

Postby Levia » Fri Apr 27, 2007 10:02

It really shouldnt be too hard to implement this somewhere.
Image

Image

Rackle
CEGUI Team (Retired)
Posts: 534
Joined: Mon Jan 16, 2006 11:59
Location: Montréal

Postby Rackle » Sat Apr 28, 2007 03:09


User avatar
tgraupmann
Quite a regular
Quite a regular
Posts: 78
Joined: Thu Aug 18, 2005 00:47
Contact:

Postby tgraupmann » Sat Apr 28, 2007 03:32

I started filling out a Wiki page for quick reference:
http://www.cegui.org.uk/wiki/index.php/SetProperty

Rackle
CEGUI Team (Retired)
Posts: 534
Joined: Mon Jan 16, 2006 11:59
Location: Montréal

Postby Rackle » Sat Apr 28, 2007 04:33

It should be possible to add an export button to my little program, to export in a Wiki format. That export could then be used to update that Wiki page, as an online reference. Something like:

Layout Properties
ID
Font
Text

Static Image Properties
ID
Font
Text

Property Help
ID
Description of this property.

Font
Description of this property.

Text
Description of this property.

User avatar
Levia
Quite a regular
Quite a regular
Posts: 83
Joined: Mon May 22, 2006 18:25
Location: Bergen op zoom, The Netherlands
Contact:

Postby Levia » Sat Apr 28, 2007 08:35

Nice one Rackle. Perhaps, like you said, something like that should be possible. Maybe ill take a look at it if you havent yet.
Image

Image

User avatar
scriptkid
Home away from home
Home away from home
Posts: 1178
Joined: Wed Jan 12, 2005 12:06
Location: The Hague, The Netherlands
Contact:

Postby scriptkid » Sat Apr 28, 2007 09:43

Very nice utility :)

I like the export idea. On a new release or a new official .skin we could add it to a reference page on the wiki indeed!

And maybe also split default- and falagard properties, as i suggested here:
http://www.cegui.org.uk/phpBB2/viewtopic.php?p=11676


Return to “Help”

Who is online

Users browsing this forum: No registered users and 15 guests