1# Qocoa
2Qocoa is a collection of Qt wrappers for OSX's Cocoa widgets.
3
4## Features
5- basic fallback to sensible Qt types on non-OSX platforms
6- shared class headers which expose no implementation details
7- typical Qt signal/slot-based API
8- trivial to import into projects (class header/implementation, [single shared global header](https://github.com/mikemcquaid/Qocoa/blob/master/qocoa_mac.h))
9
10## Building
11```
12git clone git://github.com/mikemcquaid/Qocoa.git
13cd Qocoa
14qmake # or cmake .
15make
16```
17
18## Status
19Qocoa classes are currently provided for NSButton, a spinning NSProgressIndicator and NSSearchField. There is a [TODO list](https://github.com/mikemcquaid/Qocoa/blob/master/TODO.md) for classes I hope to implement.
20
21## Usage
22For each class you want to use copy the [`qocoa_mac.h`](https://github.com/mikemcquaid/Qocoa/blob/master/qocoa_mac.h), `$CLASS.h`, `$CLASS_mac.*` and `$CLASS_nonmac.*` files into your source tree and add them to your buildsystem. Examples are provided for [CMake](https://github.com/mikemcquaid/Qocoa/blob/master/CMakeLists.txt) and [QMake](https://github.com/mikemcquaid/Qocoa/blob/master/Qocoa.pro).
23
24## Contact
25[Mike McQuaid](mailto:mike@mikemcquaid.com)
26
27## License
28Qocoa is licensed under the [MIT License](http://en.wikipedia.org/wiki/MIT_License).
29The full license text is available in [LICENSE.txt](https://github.com/mikemcquaid/Qocoa/blob/master/LICENSE.txt).
30
31The icons are taken from the [Oxygen Project](http://www.oxygen-icons.org/) and are licensed under the [Creative Commons Attribution-ShareAlike 3.0 License](http://creativecommons.org/licenses/by-sa/3.0/).
32
33## Gallery
34![Qocoa Gallery](https://github.com/mikemcquaid/Qocoa/raw/master/gallery.png)
35