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

Moved doxygen comments into the source file. Completed/extended/rewrote them. Changes to style and indentation.

Browse Source 
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@707 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Ingo Weinhold
2002-08-11 16:16:07 +00:00
parent c25a647b79
commit 36a3a8f023
2 changed files with 340 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files
headers/os/storage/NodeInfo.h
+11 -38
View File
@@ -27,70 +27,43 @@ class BBitmap;
class BResources;
//! BNodeInfo provides file type information
/*! BNodeInfo provides a nice wrapper to all sorts of usefull meta data.
* Like it's mime type, the files icon and the application which will load
* the file.
*
* @see <a href="http://www.opensource.org/licenses/mit-license.html">MIT</a>
* @author <a href="mailto:mrmlk@users.sf.net"> Michael Lloyd Lee </a>
* @author Be Inc
* @version 0
//! BNodeInfo provides file type information
/*! BNodeInfo provides a nice wrapper to all sorts of usefull meta data.
Like it's mime type, the files icon and the application which will load
the file.
\see <a href="http://www.opensource.org/licenses/mit-license.html">MIT</a>
\author <a href='mailto:bonefish@users.sf.net'>Ingo Weinhold</a>
\author <a href="mailto:[email protected]"> Michael Lloyd Lee </a>
\author Be Inc
\version 0
*/
class BNodeInfo {
public:
//! Uninitialized Constuctor
/*! After created a BNodeInfo with this, you should call \sa SetTo()
* @see SetTo(BNode *node)
*/
BNodeInfo();
//! The Constuctor
/*! @see SetTo(BNode *node)
* @param node The node to gather information on. Can be any favour */
BNodeInfo(BNode *node);
virtual ~BNodeInfo();
//! Sets the node for which you want data on
/*! @param node The node to play with
* @return <UL><li><code>B_OK</code>All is fine (still check InitCheck)</li>
* <li><code>B_BAD_VALUE</code>The node was bad</li><ul>
*/
status_t SetTo(BNode *node);
status_t SetTo(BNode *node);
//! Has it been created OK?
/*! @returns <ul><li><code>B_OK</code></li>
* <li><code>B_NO_INIT</code></li></ul>
*/
status_t InitCheck() const;
//! Gets the nodes MIME type
virtual status_t GetType(char *type) const;
//! Sets the nodes MIME type
virtual status_t SetType(const char *type);
//! Gets the nodes icon
virtual status_t GetIcon(BBitmap *icon, icon_size k = B_LARGE_ICON) const;
//! Sets the nodes icon
virtual status_t SetIcon(const BBitmap *icon, icon_size k = B_LARGE_ICON);
//! Gets the application which will open the node when a user double-clicks
status_t GetPreferredApp(char *signature,
app_verb verb = B_OPEN) const;
//! Sets the application which will open the node.
status_t SetPreferredApp(const char *signature,
app_verb verb = B_OPEN);
//! Gets a entry_ref which may point to an application which will load when
//! the user double clicks
status_t GetAppHint(entry_ref *ref) const;
//! Sets the entry_reg which should point to the app you wish to load when
//! node (icon in tracker) is double clicked
status_t SetAppHint(const entry_ref *ref);
//! Gets the icon which tracker displays
status_t GetTrackerIcon(BBitmap *icon,
icon_size k = B_LARGE_ICON) const;
//! Sets the icon which tracker will desplay
static status_t GetTrackerIcon(const entry_ref *ref,
BBitmap *icon,
icon_size k = B_LARGE_ICON);