i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Patch by John Scipione again : fix the new BIconUtils documentation.

Browse Source 
thanks!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42609 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Adrien Destugues
2011-08-09 21:57:31 +00:00
parent a33f8fbdec
commit d51bfbb57c
1 changed files with 43 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/interface/IconUtils.dox
+29 -16
View File
@@ -3,20 +3,21 @@
* Distributed under the terms of the MIT License.
*
* Documentation by:
* Adrien Destugues <[email protected]>
* Adrien Destugues <[email protected]>
* Corresponds to:
* /trunk/headers/os/interface/IconUtils.h rev 42600
* /trunk/src/kits/interface/IconUtils.cpp rev 42600
* /trunk/headers/os/interface/IconUtils.h rev 42600
* /trunk/src/kits/interface/IconUtils.cpp rev 42600
*/
/*!
\file IconUtils.h
\brief Vector icon handling utility class
\file IconUtils.h
\brief Vector icon handling utility class
*/
/*! \class BIconUtils
/*!
\class BIconUtils
\ingroup interface
\ingroup libbe
\brief The BIconUtils class provide utility methods for managing and
@@ -35,7 +36,8 @@
*/
/*! \fn static status_t BIconUtils::GetIcon(BNode* node,
/*!
\fn static status_t BIconUtils::GetIcon(BNode* node,
const char* vectorIconAttrName, const char* smallIconAttrName,
const char* largeIconAttrName, icon_size size, BBitmap* result)
\brief Utility function to import an icon from a node.
@@ -50,7 +52,8 @@
*/
/*! \fn static status_t BIconUtils::GetVectorIcon(BNode* node,
/*!
\fn static status_t BIconUtils::GetVectorIcon(BNode* node,
const char* attrName, BBitmap* result)
\brief Utility function to import a vector icon in "flat icon" format.
@@ -67,7 +70,8 @@
*/
/*! \fn static status_t BIconUtils::GetVectorIcon(const uint8* buffer,
/*!
\fn static status_t BIconUtils::GetVectorIcon(const uint8* buffer,
size_t size, BBitmap* result)
\brief Utility function to import a vector icon in "flat icon" format.
@@ -84,7 +88,8 @@
*/
/*! \fn static status_t BIconUtils::GetCMAP8Icon(BNode* node,
/*!
\fn static status_t BIconUtils::GetCMAP8Icon(BNode* node,
const char* smallIconAttrName, const char* largeIconAttrName,
icon_size size, BBitmap* icon)
\brief Utility function to import an "old" BeOS icon in B_CMAP8 colorspace.
@@ -96,7 +101,9 @@
*/
/*! \fn static status_t BIconUtils::ConvertFromCMAP8(BBitmap* source, BBitmap* result)
/*!
\fn static status_t BIconUtils::ConvertFromCMAP8(BBitmap* source,
BBitmap* result)
\brief Converts an old-style icon to another colorspace.
Utility function to convert from old icon colorspace into colorspace of
@@ -106,7 +113,9 @@
*/
/*! \fn static status_t BIconUtils::ConvertToCMAP8(BBitmap* source, BBitmap* result)
/*!
\fn static status_t BIconUtils::ConvertToCMAP8(BBitmap* source,
BBitmap* result)
\brief Converts a true-color icon to CMAP8 colorspace.
Utility function to convert data from source into \a result colorspace.
@@ -116,12 +125,16 @@
\note result should be in B_CMAP8 colorspace, and source in B_RGBA32.
*/
/*! \fn static status_t BIconUtil::ConvertFromCMAP8(const uint8* data, uint32 width,
uint32 height, uint32 bytesPerRow, BBitmap* result);
/*!
\fn static status_t BIconUtils::ConvertFromCMAP8(const uint8* data,
uint32 width, uint32 height, uint32 bytesPerRow, BBitmap* result);
\brief Convert raw data in B_CMAP8 colorspace to a B_RGBA32 BBitmap.
*/
/*! \fn static status_t BIconUtils::ConvertToCMAP8(const uint8* data, uint32 width,
uint32 height, uint32 bytesPerRow, BBitmap* result);
/*!
\fn static status_t BIconUtils::ConvertToCMAP8(const uint8* data,
uint32 width, uint32 height, uint32 bytesPerRow, BBitmap* result);
\brief Convert B_RGBA32 raw data into a B_CMAP8 BBitmap.
*/