User Tools

Site Tools


developer_guide_control

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developer_guide_control [2016/12/20 23:02]
be.ing [Read-only Controls]
developer_guide_control [2019/06/03 16:43]
hlzhs [Control Naming]
Line 9: Line 9:
 ====== Control Naming ====== ====== Control Naming ======
  
-Controls are referred to by a 2-part name called a ''​ConfigKey''​. ''​ConfigKey''​s have a ''​group''​ and an ''​item''​. The group is used to explain the category of the control while the item describes specifically what the control is. By convention, the group of a ConfigKey is wrapped with square brackets. This is because the ''​ConfigKey''​ class is also used to indicate values to store in the Mixxx preferences file which is organized like a [[http://​en.wikipedia.org/​wiki/​INI_file|Windows INI file]].+Controls are referred to by a 2-part name called a ''​ConfigKey''​. ''​ConfigKey''​s have a ''​group''​ and an ''​item''​. The group is used to explain the category of the control while the item describes specifically what the control is. 
 + 
 +By convention, the group of a ConfigKey is wrapped with square brackets. This is because the ''​ConfigKey''​ class is also used to indicate values to store in the Mixxx preferences file which is organized like a [[http://​en.wikipedia.org/​wiki/​INI_file|Windows INI file]]
 + 
 +Control items mostly use the ''​snake_case''​ naming, although some use ''​PascalCase''​ for legacy reasons. When adding new controls, ''​snake_case''​ should be used.
  
 Examples: Examples:
Line 18: Line 22:
  
 For a mostly complete list of controls which are intended to use in skins or controller mappings, see the [[mixxxcontrols|MixxxControls]] page. For a mostly complete list of controls which are intended to use in skins or controller mappings, see the [[mixxxcontrols|MixxxControls]] page.
-For a complete list, which contains also unstable internal controls, start Mixxx from the command line using ''​mixxx --developer''​. Now you can open the list by the menu: "​Developer"​ -> "​Developer Tools" ​+For a complete list, which contains also unstable internal controls, start Mixxx from the command line using ''​mixxx ​%%--%%developer''​. Now you can open the list by the menu: "​Developer"​ -> "​Developer Tools" ​
 here you can also watch and edit the current values. ​ here you can also watch and edit the current values. ​
  
developer_guide_control.txt · Last modified: 2019/06/03 16:43 by hlzhs