Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

IK documentation update

Browse Source 
* Add \since directive to each method.
* Add documentation for BScrollBar and BScrollView classes.
* Title Case group titles.
* Some other minor documentation updates.
This commit is contained in:
John Scipione 2014-06-13 17:25:02 -04:00
parent 1f424632be
commit 47852bff02
43 changed files with 5320 additions and 1277 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/user/interface/AbstractLayout.dox
View File

@ -16,9 +16,9 @@
\ingroup interface
\ingroup layout
\ingroup libbe
\brief BLayout subclass providing convenience methods for derived
implementations.
implementations.
\since Haiku R1
This class is designed to reduce the amount of boilerplate code required to
write a BLayout subclass. In most cases, you classes should derive from
@ -30,7 +30,7 @@
locally.
\warning This class is not yet finalized, if you use it in your software
assume that it will break some time in the future.
assume that it will break some time in the future.
*/
@ -44,12 +44,16 @@
/*!
\fn BAbstractLayout::BAbstractLayout()
\brief Construct a BAbstractLayout.
\since Haiku R1
*/
/*!
\fn BAbstractLayout::BAbstractLayout(BMessage* from);
\brief Archive constructor.
\since Haiku R1
*/
@ -59,6 +63,7 @@
/*!
\fn BSize BAbstractLayout::MinSize()
\copydoc BLayoutItem::MinSize()
\since Haiku R1
The return value for this method is composed (using
BLayoutUtils::ComposeSize()) from the values returned by BaseMinSize() and
@ -73,6 +78,8 @@
The return value for this method is composed (using
BLayoutUtils::ComposeSize()) from the values returned by BaseMaxSize() and
ExplicitMaxSize().
\since Haiku R1
*/
@ -83,6 +90,8 @@
The return value for this method is composed (using
BLayoutUtils::ComposeSize()) from the values returned by BasePreferredSize()
and ExplicitPreferredSize().
\since Haiku R1
*/
@ -92,13 +101,14 @@
The return value for this method is composed (using
BLayoutUtils::ComposeAlignment()) from the values returned by
BaseAlignment() and
ExplicitAlignment()
BaseAlignment() and ExplicitAlignment()
\since Haiku R1
*/
/*!
\name BAbstractLayout hooks
\name Hook Methods
@{
*/
@ -107,28 +117,34 @@
/*!
\fn BSize BAbstractLayout::BaseMinSize()
\brief Method to be implemented in derived classes return the minimum size
constraint for this BAbstractLayout.
constraint for this BAbstractLayout.
\since Haiku R1
*/
/*!
\fn BSize BAbstractLayout::BaseMaxSize()
\brief Method to be implemented in derived classes return the maximum size
constraint for this BAbstractLayout.
constraint for this BAbstractLayout.
\since Haiku R1
*/
/*!
\fn BSize BAbstractLayout::BasePreferredSize()
\brief Method to be implemented in derived classes return the preferred size
constraint for this BAbstractLayout.
constraint for this BAbstractLayout.
\since Haiku R1
*/
/*!
\fn BAlignment BAbstractLayout::BaseAlignment()
\brief Method to be implemented in derived classes return the preferred
alignment for this BAbstractLayout.
alignment for this BAbstractLayout.
*/

150
docs/user/interface/Alert.dox
View File

@ -26,12 +26,17 @@
Determines which icon (if any) is displayed in the alert dialog.
Choose one option. If the constructor doesn't include an
alert_type argument than \c B_EMPTY_ALERT is used.
\since BeOS R3
*/
/*!
\var alert_type B_EMPTY_ALERT
No icon
\since BeOS R3
*/
/*!
@ -40,6 +45,8 @@
\image html http://api.haiku-os.org/images/alert_info_32.png
Info icon
\since BeOS R3
*/
/*!
@ -48,6 +55,8 @@
\image html http://api.haiku-os.org/images/alert_idea_32.png
Idea icon
\since BeOS R3
*/
/*!
@ -56,6 +65,8 @@
\image html http://api.haiku-os.org/images/alert_warning_32.png
Warning icon
\since BeOS R3
*/
/*!
@ -64,8 +75,11 @@
\image html http://api.haiku-os.org/images/alert_stop_32.png
Stop icon
\since BeOS R3
*/
/*!
\enum button_spacing
\ingroup interface
@ -73,15 +87,21 @@
Determines how the buttons on the alert dialog are spaced relative
to each other. Choose one option. If the constructor doesn't include a
button_spacing argument than \c B_EVEN_SPACING is used.
\since BeOS R3
*/
/*!
\var button_spacing B_EVEN_SPACING
If the alert dialog has more than one button than the buttons are
spaced evenly across the bottom of the alert dialog.
\since BeOS R3
*/
/*!
\var button_spacing B_OFFSET_SPACING
@ -89,6 +109,8 @@
is offset to the left-hand side of the dialog while the rest of the
buttons are grouped on the right. This is useful to separate off a
leftmost "Cancel" or "Delete" button.
\since BeOS R3
*/
@ -97,8 +119,8 @@
\ingroup interface
\ingroup libbe
\brief The BAlert class defines a modal alert dialog which displays a short
message and provides a set of labeled buttons that allow the user to
respond.
message and provides a set of labeled buttons that allow the user to
respond.
The alert can be configured with a set of one to three buttons. These
buttons are assigned indexes 0, 1, and 2 from right-to-left respectively
@ -142,12 +164,14 @@ int32 button_index = alert->Go();
The Go() method does the work of loading up and removing the alert
window and returns the index of the button that the user selected.
\since BeOS R3
*/
/*!
\fn BAlert::BAlert(const char *title, const char *text,
const char *button1, const char *button2, const char *button3,
\fn BAlert::BAlert(const char* title, const char* text,
const char* button1, const char* button2, const char* button3,
button_width width, alert_type type)
\brief Creates and initializes a BAlert dialog.
@ -174,11 +198,14 @@ int32 button_index = alert->Go();
\li \c B_STOP_ALERT
See alert_type for details.
\since BeOS R3
*/
/*!
\fn BAlert::BAlert(const char *title, const char *text, const char *button1,
const char *button2, const char *button3, button_width width,
\fn BAlert::BAlert(const char* title, const char* text, const char* button1,
const char* button2, const char* button3, button_width width,
button_spacing spacing, alert_type type)
\brief Creates and initializes a BAlert dialog.
@ -212,43 +239,73 @@ int32 button_index = alert->Go();
\li \c B_STOP_ALERT
See alert_type for details.
\since BeOS R4
*/
/*!
\fn BAlert::BAlert(BMessage* data)
\brief Unarchives an alert from a BMessage.
\param data The archive.
\since BeOS R3
*/
/*!
\fn BAlert::~BAlert()
\brief Destructor method.
Standard Destructor method to delete a BAlert.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BAlert::Instantiate(BMessage* data)
\brief Instantiates a BAlert from a BMessage.
\param data The message to instantiate the BAlert.
\returns a BArchivable object of the BAlert.
\since BeOS R3
*/
/*!
\fn status_t BAlert::Archive(BMessage* data, bool deep) const
\brief Archives the BAlert into \a archive.
\param data The target archive which the BAlert \a data will go into.
\param deep Whether or not to recursively archive the BAlert's children.
\return A status code.
\retval B_OK The archive operation was successful.
\retval B_BAD_VALUE The archive operation failed.
\since BeOS R3
*/
//! @}
/*!
\fn void BAlert::SetShortcut(int32 index, char key)
\brief Sets the shortcut character which is mapped to a button at the
specified \a index.
specified \a index.
A button can only have one shortcut except for the rightmost button which,
in addition to the shortcut you set, is always mapped to \c B_ENTER.
@ -258,19 +315,25 @@ int32 button_index = alert->Go();
\param index The \a index of the button to set the shortcut to.
\param key The shortcut character to set.
\since BeOS R3
*/
/*!
\fn char BAlert::Shortcut(int32 index) const
\brief Gets the shortcut character which is mapped to a button at the
specified \a index.
\brief Gets the shortcut character which is mapped to a button at the
specified \a index.
\param index The \a index of the button to get the shortcut of.
\return The shortcut character mapped to the button at the specified
\a index.
\since BeOS R3
*/
/*!
\fn int32 BAlert::Go()
\brief Displays the alert window.
@ -284,8 +347,11 @@ int32 button_index = alert->Go();
window is still on screen then Go() returns -1.
\returns The index of the button clicked.
\since BeOS R3
*/
/*!
\fn status_t BAlert::Go(BInvoker* invoker)
\brief Displays the alert window from a specified \a invoker.
@ -303,27 +369,27 @@ int32 button_index = alert->Go();
window is still on screen then the message is not sent.
\returns A status code.
\since BeOS R3
*/
/*!
\fn void BAlert::MessageReceived(BMessage* msg)
\fn void BAlert::MessageReceived(BMessage* message)
\brief Initiates an action from a received message.
\param msg The message
\see BWindow::MessagedReceived()
\copydetails BWindow::MessageReceived()
*/
/*!
\fn void BAlert::FrameResized(float newWidth, float newHeight)
\brief Resizes the alert dialog.
\param newWidth The new alert dialog width.
\param newHeight The new alert dialog height.
\see BWindow::FrameResized()
\copydetails BWindow::FrameResized()
*/
/*!
\fn BButton* BAlert::ButtonAt(int32 index) const
\brief Returns a pointer to the BButton at the specified \a index.
@ -335,74 +401,80 @@ int32 button_index = alert->Go();
\param index The \a index of the desired button.
\return A pointer to the BButton at the specified \a index.
\since BeOS R3
*/
/*!
\fn BTextView* BAlert::TextView() const
\brief Returns a TextView containing the text of the Alert.
\since BeOS R3
*/
/*!
\fn BHandler* BAlert::ResolveSpecifier(BMessage* msg, int32 index,
BMessage* specifier, int32 form, const char* property)
\brief Resolves specifiers for properties.
\see BHandler::ResolveSpecifier()
\fn BHandler* BAlert::ResolveSpecifier(BMessage* message, int32 index,
BMessage* specifier, int32 what, const char* property)
\copydoc BHandler::ResolveSpecifier()
*/
/*!
\fn status_t BAlert::GetSupportedSuites(BMessage* data)
\brief Reports the suites of messages and specifiers that derived classes
understand.
\param data The message to report the suite of messages and specifiers.
\see BWindow::GetSupportedSuites()
\copydoc BWindow::GetSupportedSuites()
*/
/*!
\fn void BAlert::DispatchMessage(BMessage* msg, BHandler* handler)
\brief Sends out a message.
\see BWindow::DispatchMessage()
\copydetails BWindow::DispatchMessage()
*/
/*!
\fn void BAlert::Quit()
\brief Quits the window closing it.
\see BWindow::Quit()
\copydetails BWindow::Quit()
*/
/*!
\fn bool BAlert::QuitRequested()
\brief Hook method that gets called with the window is closed.
\returns \c true if the window closes.
\see BWindow::QuitRequested()
\copydetails BWindow::QuitRequested()
*/
/*!
\fn BPoint BAlert::AlertPosition(float width, float height)
\brief Resizes the Alert window to the width and height specified and
return the Point of the top-left corner of the Alert window.
return the Point of the top-left corner of the alert window.
\param width The desired \a width of the alert window.
\param height The desired \a height of the alert window.
\returns The BPoint of the top-left corner of the Alert window.
\since BeOS R3
*/
/*!
\fn status_t BAlert::Perform(perform_code code, void* _data)
\brief Performs an action give a perform_code and data
\brief Perform some action. (Internal Method)
Currently the only perform code available is \c PERFORM_CODE_SET_LAYOUT.
\param code The perform code.
\param _data A pointer to store some data.
\param code The perform code
\param _data A pointer to some data to perform on
\returns A status code.
\return A status code.
\sa BLooper::Perform()
\see BWindow::Perform().
\since Haiku R1
*/

116
docs/user/interface/Bitmap.dox
View File

@ -17,7 +17,7 @@
\ingroup interface
\ingroup libbe
\brief Defines the BBitmap class and global operators and functions for
handling bitmaps.
handling bitmaps.
*/
@ -64,6 +64,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
bitmap resides in you should call the Lock() and UnLock() methods. To
determine is a bitmap is currently locked you can call the IsLocked()
method.
\since BeOS R3
*/
@ -79,6 +81,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\c B_ANY_BYTES_PER_ROW to let the constructor choose an appropriate
value.
\param screenID ???
\since Haiku R1
*/
@ -94,6 +98,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
it.
\param needsContiguous If \c true a physically contiguous chunk of memory
will be allocated.
\since BeOS R3
*/
@ -108,6 +114,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
it.
\param needsContiguous If \c true a physically contiguous chunk of memory
will be allocated.
\since Haiku R1
*/
@ -117,6 +125,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\param source The source bitmap.
\param flags Creation flags.
\since Haiku R1
*/
@ -125,6 +135,18 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Creates a BBitmap object as a clone of another bitmap.
\param source The source bitmap.
\since Haiku R1
*/
/*!
\fn BBitmap::BBitmap(BMessage* data)
\brief Unarchives a bitmap from a BMessage.
\param data The archive.
\since BeOS R3
*/
@ -133,6 +155,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Destructor Method
Frees all resources associated with this object.
\since BeOS R3
*/
@ -144,21 +168,15 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
//! @{
/*!
\fn BBitmap::BBitmap(BMessage* data)
\brief Unarchives a bitmap from a BMessage.
\param data The archive.
*/
/*!
\fn BArchivable* BBitmap::Instantiate(BMessage* data)
\brief Instantiates a BBitmap from an archive.
\param data The archive.
\return A bitmap reconstructed from the archive or \c NULL, if an error
occurred.
\return A bitmap reconstructed from the archive or \c NULL if an error
occurred.
\since BeOS R3
*/
@ -168,7 +186,10 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\param data The archive.
\param deep if \c true, child object will be archived as well.
\return \c B_OK, if everything went fine, an error code otherwise.
\since BeOS R3
*/
@ -180,7 +201,10 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Gets the status of the constructor.
\returns B_OK if initialization succeeded, otherwise returns an
error status.
error status.
\since Haiku R1
*/
@ -189,6 +213,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Determines whether or not the BBitmap object is valid.
\return \c true, if the object is properly initialized, \c false otherwise.
\since BeOS R3
*/
@ -212,6 +238,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\param state Unused
\returns \c B_OK on success or an error status code.
\since Haiku R1
*/
@ -220,6 +248,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Unlocks the bitmap's buffer.
Counterpart to BBitmap::LockBits().
\since Haiku R1
*/
@ -230,6 +260,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
The bitmap must accept views, if locking should work.
\returns \c true, if the lock was acquired successfully.
\since BeOS R3
*/
@ -238,6 +270,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Unlocks the off-screen window that belongs to the bitmap.
The bitmap must accept views, if locking should work.
\since BeOS R3
*/
@ -248,6 +282,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
The bitmap must accept views, if locking should work.
\return \c true, if the caller owns a lock , \c false otherwise.
\since BeOS R4
*/
@ -267,6 +303,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Gets the ID of the area the bitmap data reside in.
\return The ID of the area the bitmap data reside in.
\since Haiku R1
*/
@ -275,6 +313,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Gets the pointer to the bitmap data.
\return The pointer to the bitmap data.
\since BeOS R3
*/
@ -283,6 +323,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Gets the length of the bitmap data.
\return The length of the bitmap data as an int32.
\since BeOS R3
*/
@ -291,6 +333,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Gets the number of bytes used to store a row of bitmap data.
\return The number of bytes used to store a row of bitmap data.
\since BeOS R3
*/
@ -299,6 +343,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Gets the bitmap's color space.
\return The bitmap's color space.
\since BeOS R3
*/
@ -307,6 +353,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Gets a BRect the size of the bitmap's dimensions.
\return A BRect the size of the bitmap's dimensions.
\since BeOS R3
*/
@ -319,21 +367,23 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
bitmap. If bitmap creation succeeded, all flags are fulfilled.
\return The bitmap's creation flags.
\since Haiku R1
*/
/*!
\fn status_t BBitmap::GetOverlayRestrictions(overlay_restrictions*
restrictions) const
\fn status_t BBitmap::GetOverlayRestrictions(
overlay_restrictions* restrictions) const
\brief Gets the overlay_restrictions structure for this bitmap.
\note This function is not part of the BeOS R5 API.
\param restrictions The overlay restrictions flag
\retval B_OK The overlay restriction structure was found.
\retval B_BAD_TYPE The overlay restriction structure for the bitmap could
not be found.
\since Haiku R1
*/
@ -375,6 +425,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
data specifying the position at which the source data shall be
written.
\param colorSpace Color space of the source data.
\since BeOS R3
*/
@ -394,8 +446,6 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
<code>B_RGB{32,24,16,15}[_BIG]</code>, \c B_CMAP8 and
<code>B_GRAY{8,1}</code>.
\note This function is not part of the BeOS R5 API.
\param data The data to be copied.
\param length The length in bytes of the data to be copied.
\param bpr The number of bytes per row in the source data.
@ -406,7 +456,9 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\retval B_OK The bits were imported into the bitmap.
\retval B_BAD_VALUE \c NULL \a data, invalid \a bpr or \a offset, or
unsupported \a colorSpace.
unsupported \a colorSpace.
\since Haiku R1
*/
@ -424,8 +476,6 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
<code>B_RGB{32,24,16,15}[_BIG]</code>, \c B_CMAP8 and
<code>B_GRAY{8,1}</code>.
\note This function is not part of the BeOS R5 API.
\param data The data to be copied.
\param length The length in bytes of the data to be copied.
\param bpr The number of bytes per row in the source data.
@ -438,6 +488,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\retval B_OK The bits were imported into the bitmap.
\retval B_BAD_VALUE: \c NULL \a data, invalid \a bpr, unsupported
\a colorSpace or invalid \a width or \a height.
\since Haiku R1
*/
@ -452,13 +504,13 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
<code>B_RGB{32,24,16,15}[_BIG]</code>, \c B_CMAP8 and
<code>B_GRAY{8,1}</code>.
\note This function is not part of the BeOS R5 API.
\param bitmap The source bitmap.
\retval B_OK The bits were imported into the bitmap.
\retval B_BAD_VALUE \c NULL \a bitmap, or \a bitmap has other dimensions,
or the conversion from or to one of the color spaces is not supported.
\since Haiku R1
*/
@ -476,8 +528,6 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
<code>B_RGB{32,24,16,15}[_BIG]</code>, \c B_CMAP8 and
<code>B_GRAY{8,1}</code>.
\note This function is not part of the BeOS R5 API.
\param bitmap The source bitmap.
\param from The offset in the source where reading should begin.
\param to The offset in the bitmap where the source should be written.
@ -487,6 +537,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\retval B_OK The bits were imported into the bitmap.
\retval B_BAD_VALUE \c NULL \a bitmap, the conversion from or to one of
the color spaces is not supported, or invalid \a width or \a height.
\since Haiku R1
*/
@ -494,7 +546,7 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
/*!
\name Child View Methods
\name View Hierarchy
*/
@ -509,6 +561,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
another parent.
\param view The view to be added.
\since BeOS R3
*/
@ -517,6 +571,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Removes a BView from the bitmap's view hierarchy.
\param view The view to be removed.
\since BeOS R3
*/
@ -525,6 +581,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\brief Gets the number of BViews currently belonging to the bitmap.
\returns The number of BViews currently belonging to the bitmap.
\since BeOS R3
*/
@ -535,6 +593,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\param index The index of the BView to be returned.
\returns The BView at index \a index or \c NULL if the index is out of
range.
\since BeOS R3
*/
@ -545,6 +605,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\param viewName The name of the BView to be returned.
\returns The BView with the name \a name or \c NULL if the bitmap doesn't
know a view with that name.
\since BeOS R3
*/
@ -555,6 +617,8 @@ appFileInfo.GetIcon(iconBitmap, B_LARGE_ICON);
\param point The location.
\returns The BView with located at \a point or \c NULL if the bitmap
doesn't know a view at this location.
\since BeOS R3
*/

71
docs/user/interface/Box.dox
View File

@ -33,6 +33,8 @@
A box's label can either be composed of text or it can be a view such
as a checkbox or dropdown box. See SetLabel() for more details on setting
the box's label.
\since BeOS R3
*/
@ -49,9 +51,11 @@
\param frame The bounds of the box.
\param name The name of the box.
\param resizingMode Defines the behavior of the box as the parent view
resizes. See BView for details.
resizes. See BView for details.
\param flags Behavior flags for the box. See BView for details.
\param border The border_style of the box.
\since BeOS R3
*/
@ -67,6 +71,8 @@
\param border The border_style of the box.
\param child Adds an initial child to the Box object. See the Layout
API for details.
\since Haiku R1
*/
@ -77,6 +83,8 @@
There can only be a single child view. This view can, however, act as a
nesting container if you need to show more items inside the box.
\since Haiku R1
*/
@ -92,6 +100,8 @@
child views recursively.
\param archive The \a archive message to restore from.
\since BeOS R3
*/
@ -101,9 +111,19 @@
Calling the destructor will also free the memory used by the box's label
if it has one.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn static BArchivable* BBox::Instantiate(BMessage* archive)
\brief Creates a new object from an \a archive.
@ -117,11 +137,13 @@
\returns An instance of the object if \a archive is valid or \c NULL.
\sa BArchivable::Instantiate()
\since BeOS R3
*/
/*!
\fn virtual status_t BBox::Archive(BMessage* archive,
\fn virtual status_t BBox::Archive(BMessage* archive,
bool deep = true) const;
\brief Archives the object into \a archive.
@ -133,9 +155,14 @@
\retval B_ERROR The archive operation failed.
\sa BArchivable::Archive()
\since BeOS R3
*/
//! @}
/*!
\fn virtual void BBox::SetBorder(border_style border)
\brief Sets the #border_style.
@ -146,6 +173,8 @@
- \c B_NO_BORDER Used to make a borderless box.
\param border The #border_style to set.
\since BeOS R3
*/
@ -159,6 +188,8 @@
- \c B_NO_BORDER Used to make a borderless box.
\returns The #border_style of the box.
\since BeOS R3
*/
@ -167,8 +198,7 @@
\brief Gets the distance from the very top of the box to the top border
line in pixels.
\warning This method is not part of the BeOS R5 API and is not yet
finalized.
\warning This method is not yet finalized.
The distance may vary depending on the text or view used as label and the
font settings. The border is drawn center-aligned with the label. This
@ -177,6 +207,8 @@
\returns The distance from the very top of the box to the top border
line in pixels as a \c float.
\since Haiku R1
*/
@ -184,10 +216,11 @@
\fn BRect BBox::InnerFrame()
\brief Gets the frame rectangle just inside the border of the box.
\warning This method is not part of the BeOS R5 API and is not yet
finalized.
\warning This method is not yet finalized.
\returns A BRect set to the dimensions of the box's inside border.
\since Haiku R1
*/
@ -206,6 +239,8 @@ fIconBox->SetLabel("Icon");
\endcode
\param string The label text string to set as the box's title.
\since BeOS R3
*/
@ -232,6 +267,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
\param viewLabel A BView.
\returns \c B_OK
\since BeOS R3
*/
@ -245,6 +282,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
\returns The label text of the BBox if the box has a text label or
\c NULL otherwise.
\since BeOS R3
*/
@ -253,6 +292,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
\brief Gets the BView representing the label.
\returns a pointer to a BView object.
\since BeOS R4
*/
@ -265,6 +306,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
consider calling Invalidate() instead.
\param updateRect The rectangular area to be drawn.
\since BeOS R3
*/
@ -280,6 +323,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
the layout of the parent view.
\sa BView::AttachedToWindow()
\since BeOS R3
*/
@ -292,6 +337,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
This method recomputes the layout of the BBox (including label and
contents) and makes it redraw as necessary.
\since BeOS R3
*/
@ -300,6 +347,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
\brief Resizes the box to its preferred dimensions.
\note This only works in the non-layout mode, as it forces the resizing.
\since BeOS R3
*/
@ -317,6 +366,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
\param[out] _width Pointer to a \c float to store the width of the view.
\param[out] _height Pointer to a \c float to store the height of the view.
\since BeOS R3
*/
@ -327,6 +378,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
Drawing the box at this size ensures the label and the child view are
visible. Reducing the size even more would mean that a view would not
be visible.
\since Haiku R1
*/
@ -337,6 +390,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
The maximum size depends on the maximize size of the child views.
\returns The maximum possible size of the BBox as a BSize.
\since Haiku R1
*/
@ -348,6 +403,8 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
convenient BSize object.
\returns The minimum possible size of the BBox as a BSize.
\since Haiku R1
*/
@ -363,4 +420,6 @@ fVirtualMemoryBox->SetLabel(fVirtualMemoryEnabledCheckBox);
label, eventually truncating the label text if there is not enough space.
The exact border positions are also computed, then the child view is also
laid out if its size constraints change.
\since Haiku R1
*/

178
docs/user/interface/Button.dox
View File

@ -44,6 +44,8 @@
label is set in the constructor or by the SetLabel() method. To set the
icon for a button use the SetIcon() method. The text label will draw
to the right of the icon.
\since BeOS R3
*/
@ -73,6 +75,8 @@
resized. See BView for more information on resizing options.
\param flags The \a flags mask sets what notifications the BButton can
receive. See BView for more information on \a flags.
\since BeOS R3
*/
@ -92,6 +96,8 @@
\param message The button's action \a message. Can be \c NULL.
\param flags The \a flags mask sets what notifications the button can
receive. See BView for more information on \a flags.
\since Haiku R1
*/
@ -104,6 +110,8 @@
\param label The button's \a label text. Can be \c NULL.
\param message The buttons action \a message. Can be \c NULL.
\since Haiku R1
*/
@ -118,12 +126,16 @@
of its child views recursively.
\param data The \a data message to restore from.
\since BeOS R3
*/
/*!
\fn BButton::~BButton()
\brief Destructor, does nothing.
\since BeOS R3
*/
@ -139,8 +151,12 @@
\fn BArchivable* BButton::Instantiate(BMessage* archive)
\brief Creates a new BButton object from the \a archive message.
\param archive The \a archive message to restore from.
\return A newly created check box or \c NULL if the message doesn't
contain an archived BButton.
\since BeOS R3
*/
@ -155,6 +171,8 @@
otherwise.
\sa BControl::Archive()
\since BeOS R3
*/
@ -177,6 +195,8 @@
the default button the window's default button is updated.
\sa BControl::AttachedToWindow()
\since BeOS R3
*/
@ -184,9 +204,7 @@
\fn void BButton::DetachedFromWindow()
\brief Hook method called when the button is detached from a window.
The default implementation does nothing.
\sa BControl::DetachedFromWindow()
\copydetails BControl::DetachedFromWindow()
*/
@ -195,9 +213,7 @@
\brief Similar to AttachedToWindow() but this method is triggered after
all child views have already been attached to a window.
The default implementation does nothing.
\sa BView::AllAttached()
\copydetails BView::AllAttached()
*/
@ -206,9 +222,7 @@
\brief Similar to AttachedToWindow() but this method is triggered after
all child views have already been detached from a window.
The default implementation does nothing.
\sa BView::AllDetached()
\copydetails BView::AllDetached()
*/
@ -224,6 +238,8 @@
\param updateRect The rectangular area to be drawn.
\sa BView::Draw()
\since BeOS R3
*/
@ -231,24 +247,15 @@
\fn void BButton::FrameMoved(BPoint newPosition)
\brief Hook method called when the button is moved.
The default implementation does nothing.
\param newPosition The point that the button has been moved to.
\sa BView::FrameMoved()
\copydetails BView::FrameMoved()
*/
/*!
\fn void BButton::FrameResized(float width, float height)
\fn void BButton::FrameResized(float newWidth, float newHeight)
\brief Hook method called when the button is resized.
The default implementation does nothing.
\param width The new \a width of the button.
\param height The new \a height of the button.
\sa BView::FrameResized()
\copydetails BView::FrameResized()
*/
@ -260,6 +267,8 @@
\param bytes The bytes of the key combination pressed.
\param numBytes The number of bytes in \a bytes.
\since BeOS R3
*/
@ -269,9 +278,9 @@
Invalidate cached preferred size.
\note This method was not available in BeOS R5.
\param descendants Whether or not child views have also been invalidated.
\since Haiku R1
*/
@ -279,11 +288,7 @@
\fn void BButton::MessageReceived(BMessage* message)
\brief Handle \a message received by the associated looper.
The default implemenation does nothing.
\param message The \a message received by the associated looper.
\see BControl::MessageReceived()
\copydetails BControl::MessageReceived()
*/
@ -293,8 +298,7 @@
Begins tracking the mouse cursor.
\param where The point on the screen where to mouse pointer is when
the mouse button is pressed.
\copydetails BControl::MouseDown()
*/
@ -307,19 +311,7 @@
if the mouse cursor is inside the button. The value that is set depends on
if the button is using \c B_TOGGLE_BEHAVIOR or not.
\param where The new location of the mouse in the control's coordinate system.
\param code One of the following:
- \c B_ENTERED_VIEW The cursor has just entered the button.
- \c B_INSIDE_VIEW The cursor is inside the button.
- \c B_EXITED_VIEW The cursor has left the button's bounds. This only gets
sent if the scope of the mouse events that the button can receive has
been expanded by BView::SetEventMask() or BView::SetMouseEventMask().
- \c B_OUTSIDE_VIEW The cursor is outside the button. This only gets sent if
the scope of the mouse events that the control can receive has been
expanded by SetEventMask() or SetMouseEventMask().
\param dragMessage If a drag-and-drop operation is taking place this is a
pointer to a BMessage that holds the drag information, otherwise the
pointer is \c NULL.
\copydetails BControl::MouseMoved()
*/
@ -331,8 +323,7 @@
button. The value that is set depends on if the button is using
\c B_TOGGLE_BEHAVIOR or not.
\param where The point on the screen where the mouse pointer is located when
the mouse button is released in the view's coordinate system.
\copydetails BControl::MouseUp()
*/
@ -341,12 +332,7 @@
\brief Hook method called when the attached window is activated or
deactivated.
The default implementation does nothing.
\param active \c true if the window becomes activated, \c false if the
window becomes deactivated.
\sa BControl::WindowActivated()
\copydetails BControl::WindowActivated()
*/
@ -358,15 +344,7 @@
\brief Fill out the preferred width and height of the button
into the \a _width and \a _height parameters.
The size is computed from the children sizes, unless it was explicitly set
for the BButton, which can be done only if the BButton is configured to
use the Layout APIs.
\note Either the \a _width or \a _height parameter may be set to \c NULL
if you only want to get the other one.
\param[out] _width Pointer to a \c float to store the width.
\param[out] _height Pointer to a \c float to store the height.
\copydetails BControl::GetPreferredSize()
*/
@ -374,12 +352,7 @@
\fn status_t BButton::GetSupportedSuites(BMessage* message)
\brief Report the suites of messages this control understands.
\param message Allows you to add the names of the suites the button
implements to the suites array.
\return \c B_OK if all went well or an error code otherwise.
\sa BControl::GetSupportedSuites();
\copydetails BControl::GetSupportedSuites();
*/
@ -387,12 +360,7 @@
\fn status_t BButton::Invoke(BMessage* message)
\brief Sends a copy of the model \a message to the designated target.
\param message The \a message to send.
\return \c B_OK if the button was invoked, otherwise an error
code is returned.
\sa BControl::Invoke()
\copydetails BControl::Invoke()
*/
@ -407,19 +375,17 @@
to remove the default button status.
\sa BWindow::SetDefaultButton()
\since BeOS R3
*/
/*!
\fn void BButton::MakeFocus(bool focused)
\fn void BButton::MakeFocus(bool focus)
\brief Makes the button the current focus view of the window or
gives up being the window's focus view.
The default implementation does nothing.
\param focused \a true to set focus, \a false to remove it.
\sa BControl::MakeFocus()
\copydetails BControl::MakeFocus()
*/
@ -427,9 +393,9 @@
\fn BSize BButton::MinSize()
\brief Returns the button's minimum size.
\note This method was not available in BeOS R5.
\return The button's minimum size as a BSize.
\since Haiku R1
*/
@ -437,9 +403,9 @@
\fn BSize BButton::MaxSize()
\brief Returns the button's maximum size.
\note This method was not available in BeOS R5.
\return The button's maximum size as a BSize.
\since Haiku R1
*/
@ -447,15 +413,15 @@
\fn BSize BButton::PreferredSize()
\brief Returns the button's preferred size.
\note This method was not available in BeOS R5.
\return The button's preferred size as a BSize.
\since Haiku R1
*/
/*!
\fn status_t BButton::Perform(perform_code code, void* _data)
\brief Perform some action. (Internal Method)
\copydoc BView::Perform()
*/
@ -463,18 +429,14 @@
\fn void BButton::ResizeToPreferred()
\brief Resize the button to its preferred size.
\sa BView::ResizeToPreferred()
\copydetails BView::ResizeToPreferred()
*/
/*!
\fn BHandler* BButton::ResolveSpecifier(BMessage* message,
int32 index, BMessage* specifier, int32 what, const char* property)
\brief Determine the proper specifier for scripting messages.
The default implementation does nothing.
\sa BControl::ResolveSpecifier()
\copydoc BHandler::ResolveSpecifier()
*/
@ -483,6 +445,8 @@
\brief Sets the button's label.
\param label The string to set the label to.
\since BeOS R3
*/
@ -492,6 +456,8 @@
window, i.e. whether or not it responds to the \key{Enter} key.
\returns \c true if the button is the default button, \c false otherwise.
\since BeOS R3
*/
@ -499,9 +465,9 @@
\fn bool BButton::IsFlat() const
\brief Returns whether or not the button is flat or not.
\note This method was not available in BeOS R5.
\returns \c true if the button is flat, \c false otherwise.
\since Haiku R1
*/
@ -509,10 +475,10 @@
\fn void BButton::SetFlat(bool flat)
\brief Sets or unsets the button to be flat.
\note This method was not available in BeOS R5.
\param flat \c true to make the button flat, \c false to make the button
not flat.
\since Haiku R1
*/
@ -520,9 +486,9 @@
\fn BButton::BBehavior BButton::Behavior() const
\brief Returns the buttons behavior.
\note This method was not available in BeOS R5.
\return The button behavior flag.
\since Haiku R1
*/
@ -530,13 +496,13 @@
\fn void BButton::SetBehavior(BBehavior behavior)
\brief Sets the button behavior.
\note This method was not available in BeOS R5.
\param behavior One of the following:
- \c B_BUTTON_BEHAVIOR Normal behavior,
- \c B_TOGGLE_BEHAVIOR Acts like a check box,
- \c B_POP_UP_BEHAVIOR Adds a pop-up marker to the button
(similar to that of BMenuField).
\since Haiku R1
*/
@ -545,9 +511,9 @@
\brief Returns the message sent to the button's target when the
pop-up marker is selected using \c B_POP_UP_BEHAVIOR.
\note This method was not available in BeOS R5.
\return The message sent to the button's target.
\since Haiku R1
*/
@ -556,9 +522,9 @@
\brief Sets the message sent to the button's target when the
pop-up marker is selected using \c B_POP_UP_BEHAVIOR.
\note This method was not available in BeOS R5.
\param message The \a message sent to the button's target.
\since Haiku R1
*/
@ -567,14 +533,14 @@
\brief This convenience method is used to set the bitmaps
for the standard states from a single bitmap.
\note This method was not available in BeOS R5.
\param icon The \a icon to set.
\param flags Modify how the icon is set.
\return \c B_OK if the icon was set or an error code otherwise.
\sa BControl::SetIcon()
\since Haiku R1
*/
@ -590,4 +556,6 @@
- \c 1 (\c B_CONTROL_ON)
\see BControl::SetValue()
\since BeOS R3
*/

108
docs/user/interface/CheckBox.dox
View File

@ -42,6 +42,8 @@
state, and another unchecked check box with focus on it.
\image html BCheckBox_example.png
\since BeOS R3
*/
@ -64,6 +66,8 @@
\param resizingMode Defines the behavior of the check box as the parent
view resizes. See BView for details.
\param flags Behavior \a flags for the check box. See BView for details.
\since BeOS R3
*/
@ -81,6 +85,8 @@
\param message The \a message to send when the check box is activated.
See BView for details.
\param flags Behavior \a flags for the check box. See BView for details.
\since Haiku R1
*/
@ -94,6 +100,8 @@
\param label The \a label displayed along with the check box.
\param message The \a message to send when the check box is activated.
\since Haiku R1
*/
@ -106,12 +114,16 @@
because it can handle errors properly.
\param archive The message to construct the BCheckBox object from.
\since BeOS R3
*/
/*!
\fn BCheckBox::~BCheckBox()
\brief Destructor, does nothing.
\since BeOS R3
*/
@ -127,8 +139,12 @@
\fn BArchivable* BCheckBox::Instantiate(BMessage* archive)
\brief Creates a new BCheckBox object from the \a archive message.
\param archive The \a archive message to restore from.
\return A newly created check box or \c NULL if the message doesn't
contain an archived BCheckBox.
\since BeOS R3
*/
@ -136,13 +152,7 @@
\fn status_t BCheckBox::Archive(BMessage* data, bool deep) const
\brief Archives the object into the \a data message.
\param data A pointer to the BMessage object to archive the object into.
\param deep Whether or not to archive child views as well.
\return A status code, \c B_OK if everything went well or an error code
otherwise.
\sa BControl::Archive()
\copydetails BControl::Archive()
*/
@ -161,9 +171,7 @@
\fn void BCheckBox::AttachedToWindow()
\brief Hook method called when the control is attached to a window.
The default implementation does nothing.
\sa BControl::AttachedToWindow()
\copydetails BControl::AttachedToWindow()
*/
@ -171,9 +179,7 @@
\fn void BCheckBox::DetachedFromWindow()
\brief Hook method called when the control is detached from a window.
The default implementation does nothing.
\sa BControl::DetachedFromWindow()
\copydetails BControl::DetachedFromWindow()
*/
@ -182,9 +188,7 @@
\brief Similar to AttachedToWindow() but this method is triggered after
all child views have already been attached to a window.
The default implementation does nothing.
\sa BView::AllAttached()
\copydetails BView::AllAttached()
*/
@ -193,9 +197,7 @@
\brief Similar to AttachedToWindow() but this method is triggered after
all child views have already been detached from a window.
The default implementation does nothing.
\sa BView::AllDetached()
\copydetails BView::AllDetached()
*/
@ -210,6 +212,8 @@
\param updateRect The rectangular area to be drawn.
\sa BView::Draw()
\since BeOS R3
*/
@ -217,24 +221,15 @@
\fn void BCheckBox::FrameMoved(BPoint newPosition)
\brief Hook method called when the check box is moved.
The default implementation does nothing.
\param newPosition The point that the check box has been moved to.
\sa BView::FrameMoved()
\copydetails BView::FrameMoved()
*/
/*!
\fn void BCheckBox::FrameResized(float width, float height)
\fn void BCheckBox::FrameResized(float newWidth, float newHeight)
\brief Hook method called when the check box is resized.
The default implementation does nothing.
\param width The new \a width of the check box.
\param height The new \a height of the check box.
\sa BView::FrameResized()
\copydetails BView::FrameResized()
*/
@ -243,8 +238,7 @@
\brief Fill out the preferred width and height of the check box
into the \a _width and \a _height parameters.
\param[out] _width Pointer to a \c float to store the width.
\param[out] _height Pointer to a \c float to store the height.
\copydetails BView::GetPreferredSize()
*/
@ -258,8 +252,9 @@
\return \c B_OK if all went well or an error code otherwise.
\sa BControl::GetSupportedSuites();
*/
\since BeOS R3
*/
/*!
@ -268,8 +263,7 @@
Inverts the value on \a B_ENTER or \a B_SPACE.
\param bytes The bytes of the key combination pressed.
\param numBytes The number of bytes in \a bytes.
\copydetails BControl::KeyDown()
*/
@ -277,9 +271,7 @@
\fn void BCheckBox::MessageReceived(BMessage* message)
\brief Handle \a message received by the associated looper.
\param message The \a message received by the associated looper.
\see BControl::MessageReceived()
\copydetails BControl::MessageReceived()
*/
@ -289,8 +281,7 @@
Begins tracking the mouse cursor.
\param where The point on the screen where to mouse pointer is when
the mouse button is pressed.
\copydetails BControl::MouseDown()
*/
@ -302,19 +293,7 @@
Once MouseDown() has been called on a check box this method updates
the outline when the cursor is inside the control redrawing as necessary.
\param where The new location of the mouse in the control's coordinate system.
\param code One of the following:
- \c B_ENTERED_VIEW The cursor has just entered the control.
- \c B_INSIDE_VIEW The cursor is inside the control.
- \c B_EXITED_VIEW The cursor has left the control's bounds. This only gets
sent if the scope of the mouse events that the control can receive has
been expanded by BView::SetEventMask() or BView::SetMouseEventMask().
- \c B_OUTSIDE_VIEW The cursor is outside the button. This only gets sent if
the scope of the mouse events that the control can receive has been
expanded by SetEventMask() or SetMouseEventMask().
\param dragMessage If a drag-and-drop operation is taking place this is a
pointer to a BMessage that holds the drag information, otherwise the
pointer is \c NULL.
\copydetails BControl::MouseMoved()
*/
@ -324,10 +303,7 @@
Inverts the check box value.
\param where The point on the screen where the mouse pointer is located when
the mouse button is released in the view's coordinate system.
\sa BControl::MouseUp()
\copydetails BControl::MouseUp()
*/
@ -337,12 +313,7 @@
\brief Hook method called when the attached window is activated or
deactivated.
The default implementation does nothing.
\param active \c true if the window becomes activated, \c false if the
window becomes deactivated.
\sa BControl::WindowActivated()
\copydetails BControl::WindowActivated()
*/
@ -357,4 +328,13 @@
either \c B_CONTROL_ON or \c B_CONTROL_OFF.
\sa BControl::SetValue()
\since BeOS R3
*/
/*!
\fn BHandler* BCheckBox::ResolveSpecifier(BMessage* message, int32 index,
BMessage* specifier, int32 what, const char* property)
\copydoc BHandler::ResolveSpecifier()
*/

92
docs/user/interface/ColorControl.dox
View File

@ -24,36 +24,53 @@
\ingroup interface
Enumeration of the color control layout options.
\since BeOS R3
*/
/*!
\var color_control_layout B_CELLS_4x64
Cells are arranged in 4 columns, 64 rows.
\since BeOS R3
*/
/*!
\var color_control_layout B_CELLS_8x32
Cells are arranged in 8 columns, 32 rows.
\since BeOS R3
*/
/*!
\var color_control_layout B_CELLS_16x16
Cells are arranged in 16 columns, 16 rows.
\since BeOS R3
*/
/*!
\var color_control_layout B_CELLS_32x8
Cells are arranged in 32 columns, 8 rows.
\since BeOS R3
*/
/*!
\var color_control_layout B_CELLS_64x4
Cells are arranged in 64 columns, 4 rows.
\since BeOS R3
*/
@ -94,6 +111,8 @@ colorControl->SetValue(0x336698);
\image html BColorControl_example_256_colors.png
You can set the size of these cells by calling the SetCellSize() method.
\since BeOS R3
*/
@ -121,27 +140,33 @@ colorControl->SetValue(0x336698);
made to an off-screen bitmap and then copied to the screen
making the drawing smoother, but requiring more memory
(currently unused).
\since BeOS R3
*/
/*!
\fn BColorControl::BColorControl(BMessage* archive)
\brief Constructs a BColorControl object from an \a archive message.
\fn BColorControl::BColorControl(BMessage* data)
\brief Constructs a BColorControl object from an \a data message.
This method is usually not called directly. If you want to build a
color control from a message you should call Instantiate() which can
handle errors properly.
If the \a archive deep, the BColorControl object will also unarchive
If the \a data deep, the BColorControl object will also undata
each of its child views recursively.
\param archive The \a archive message to restore from.
\param data The \a data message to restore from.
\since BeOS R3
*/
/*!
\fn BColorControl::~BColorControl()
\brief Destructor method.
\since BeOS R3
*/
@ -152,6 +177,8 @@ colorControl->SetValue(0x336698);
\param layout The \a layout to set.
\sa BView::SetLayout()
\since Haiku R1
*/
@ -167,8 +194,9 @@ colorControl->SetValue(0x336698);
- \c B_CELLS_32x8
\param layout The color control layout to set.
*/
\since BeOS R3
*/
/*!
@ -176,6 +204,8 @@ colorControl->SetValue(0x336698);
\brief Set the color of the BColorControl to \a value.
\param value The 32-bit color value to set.
\since BeOS R3
*/
@ -184,6 +214,8 @@ colorControl->SetValue(0x336698);
\brief Set the color of the BColorControl to \a color.
\param color The rgb_color to set.
\since BeOS R3
*/
@ -192,6 +224,8 @@ colorControl->SetValue(0x336698);
\brief Return the current color value as an rgb_color.
\returns The current color as an rgb_color.
\since BeOS R3
*/
@ -200,6 +234,8 @@ colorControl->SetValue(0x336698);
\brief Enable and disable the color control.
\param enabled Whether to enable or disable the color control.
\since BeOS R3
*/
@ -214,6 +250,8 @@ colorControl->SetValue(0x336698);
\sa BControl::AttachedToWindow()
\sa BView::SetViewColor()
\since BeOS R3
*/
@ -228,6 +266,8 @@ colorControl->SetValue(0x336698);
\param updateRect The area to be drawn.
\sa BView::Draw()
\since BeOS R3
*/
@ -236,6 +276,8 @@ colorControl->SetValue(0x336698);
\brief Set the size of the color cell in the color control.
\param cellSide The cell size to set.
\since BeOS R3
*/
@ -244,6 +286,8 @@ colorControl->SetValue(0x336698);
\brief Get the current color cell size.
\returns the current color cell size as a float.
\since BeOS R3
*/
@ -252,6 +296,8 @@ colorControl->SetValue(0x336698);
\brief Get the current color control layout.
\returns The current color_control_layout
\since BeOS R3
*/
@ -260,7 +306,7 @@ colorControl->SetValue(0x336698);
\brief Hook method that is called when the object is detached from a
window.
\sa BView::DetachedFromWindow()
\copydetails BControl::DetachedFromWindow()
*/
@ -273,6 +319,8 @@ colorControl->SetValue(0x336698);
\param _height Pointer to a \c float to hold the height of the checkbox.
\sa BView::GetPreferredSize()
\since BeOS R3
*/
@ -281,47 +329,53 @@ colorControl->SetValue(0x336698);
\brief Resize the color control to its preferred size.
\sa BView::ResizeToPreferred()
\since BeOS R3
*/
/*!
\fn status_t BColorControl::Invoke(BMessage *msg)
\fn status_t BColorControl::Invoke(BMessage* message)
\brief Tells the messenger to send a message.
\param msg The message to send.
\param message The message to send.
\sa BControl::Invoke()
\since BeOS R3
*/
/*!
\fn void BColorControl::FrameMoved(BPoint new_position)
\fn void BColorControl::FrameMoved(BPoint newPosition)
\brief Hook method that gets called when the color control is moved.
\param new_position The point that the top left corner of the frame
is moved to.
\sa BView::FrameMoved()
\copydetails BView::FrameMoved()
*/
/*!
\fn void BColorControl::FrameResized(float new_width, float new_height)
\fn void BColorControl::FrameResized(float newWidth, float newHeight)
\brief Hook method that gets called when the checkbox is resized.
\param new_width The new width of the checkbox.
\param new_height The new height of the checkbox.
\sa BView::FrameResized()
\copydetails BView::FrameResized()
*/
/*!
\fn void BColorControl::MakeFocus(bool state)
\brief Gives focus to or removes focus from the color control.
\brief Gives focus to or removes focus from the control.
\param state \a true to set focus, \a false to remove it.
\sa BControl::MakeFocus()
\since BeOS R3
*/
/*!
\fn BHandler* BColorControl::ResolveSpecifier(BMessage* message,
int32 index, BMessage* specifier, int32 what, const char* property)
\copydoc BHandler::ResolveSpecifier()
*/

199
docs/user/interface/Control.dox
View File

@ -23,6 +23,8 @@
\var B_CONTROL_ON
Control on. Value equal to 1.
\since BeOS R3
*/
@ -30,6 +32,8 @@
\var B_CONTROL_OFF
Control off. Value equal to 0.
\since BeOS R3
*/
@ -52,6 +56,8 @@
values that you can use as a convenience if your control has a simple
on/off state. If your BControl derived class stores a larger set of
states then you should define your own integer values instead.
\since BeOS R3
*/
@ -71,6 +77,8 @@
\param resizingMode Defines the behavior of the control as the parent
view resizes, see BView for more details.
\param flags Behavior \a flags for the control, see BView for details.
\since BeOS R3
*/
@ -83,12 +91,12 @@
The initial value of the control is set to 0 (\c B_CONTROL_OFF).
The \a label and the \a message parameters can be set to \c NULL.
\note This method was not available in BeOS R5.
\param name The \a name of the control.
\param label The \a label displayed along with the control.
\param message The \a message to send when the control is activated.
\param flags Behavior \a flags for the control, see BView for details.
\since Haiku R1
*/
@ -96,67 +104,88 @@
\fn BControl::~BControl()
\brief Frees all memory used by the BControl object including the memory
used by the model message.
\since BeOS R3
*/
/*!
\fn BControl::BControl(BMessage* archive)
\brief Creates a new BControl object from an \a archive message.
\name Archiving
*/
//! @{
/*!
\fn BControl::BControl(BMessage* data)
\brief Creates a new BControl object from an \a data message.
This method is usually not called directly. If you want to build a
control from a message you should call Instantiate() which can
handle errors properly.
If the \a archive deep, the BControl object will also unarchive each
If the \a data deep, the BControl object will also undata each
of its child views recursively.
\param archive The \a archive message to restore from.
\param data The \a data message to restore from.
\since BeOS R3
*/
/*!
\fn BArchivable* BControl::Instantiate(BMessage* archive)
\brief Creates a new object from an \a archive.
\fn BArchivable* BControl::Instantiate(BMessage* data)
\brief Creates a new object from an \a data.
If the message is a valid object then the instance created from the
passed in \a archive will be returned. Otherwise this method will
passed in \a data will be returned. Otherwise this method will
return \c NULL.
\param archive The \a archive message.
\param data The \a data message.
\returns An instance of the object if \a archive is valid or \c NULL.
\returns An instance of the object if \a data is valid or \c NULL.
\sa BArchivable::Instantiate()
\since BeOS R3
*/
/*!
\fn status_t BControl::Archive(BMessage* archive, bool deep) const
\brief Archives the control into \a archive.
\fn status_t BControl::Archive(BMessage* data, bool deep) const
\brief Archives the control into \a data.
\param archive The target \a archive that the data will go into.
\param deep Whether or not to recursively archive child views.
\param data The target \a data that the data will go into.
\param deep Whether or not to recursively data child views.
\retval B_OK The archive operation was successful.
\retval B_BAD_VALUE \c NULL \a archive message.
\retval B_OK The data operation was successful.
\retval B_BAD_VALUE \c NULL \a data message.
\retval B_ERROR The archive operation failed.
\sa BArchivable::Archive()
\since BeOS R3
*/
//! @}
/*!
\fn void BControl::WindowActivated(bool active)
\brief Hook method called when the attached window is activated or
deactivated.
Redraws the focus ring around the menu field when the window is activated
Redraws the focus ring around the control when the window is activated
or deactivated if it is the window's current focus view.
\param active \c true if the window becomes activated, \c false if the
window becomes deactivated.
\sa BView::WindowActivated()
\since BeOS R3
*/
@ -172,27 +201,25 @@
\sa BView::AttachedToWindow()
\sa Invoke()
\sa BInvoker::SetTarget()
\since BeOS R3
*/
/*!
\fn void BControl::DetachedFromWindow()
\brief Hook method called when the object is detached from a window.
\brief Hook method called when the control is detached from a window.
The default implementation does nothing.
\sa BView::DetachedFromWindow()
\copydetails BView::DetachedFromWindow()
*/
/*!
\fn void BControl::AllAttached()
\brief Similar to AttachedToWindow() but this method is triggered after
all child views have already been attached to a window.
all child views have already been detached from a window.
The default implementation does nothing.
\sa BView::AllAttached()
\copydetails BView::AllAttached()
*/
@ -201,14 +228,12 @@
\brief Similar to AttachedToWindow() but this method is triggered after
all child views have already been detached from a window.
The default implementation does nothing.
\sa BView::AllDetached()
\copydetails BView::AllDetached()
*/
/*!
\fn void BControl::MakeFocus(bool focused)
\fn void BControl::MakeFocus(bool focus)
\brief Gives or removes focus from the control.
BControl::MakeFocus() overrides BView::MakeFocus() to call Draw() when
@ -217,10 +242,12 @@
IsFocusChanging() returns \c true when Draw() is called from this method.
\param focused \a true to set focus, \a false to remove it.
\param focus \a true to set focus, \a false to remove it.
\sa BView::MakeFocus()
\sa IsFocusChanging()
\since BeOS R3
*/
@ -241,6 +268,8 @@
\sa BView::KeyDown()
\sa MakeFocus()
\since BeOS R3
*/
@ -248,9 +277,7 @@
\fn void BControl::MessageReceived(BMessage* message)
\brief Handle \a message received by the associated looper.
\param message The \a message received by the associated looper.
\see BView::MessageReceived()
\copydetails BView::MessageReceived()
*/
@ -258,21 +285,7 @@
\fn void BControl::MouseDown(BPoint where)
\brief Hook method called when a mouse button is pressed.
\param where The point on the screen where the mouse pointer is when
the mouse button is pressed in the view's coordinate system.
\sa BView::MouseDown()
*/
/*!
\fn void BControl::MouseUp(BPoint where)
\brief Hook method called when a mouse button is released.
\param where The point on the screen where the mouse pointer is located
when the mouse button is released in the view's coordinate system.
\sa BView::MouseUp()
\copydetails BView::MouseDown()
*/
@ -281,24 +294,19 @@
const BMessage* dragMessage)
\brief Hook method called when the mouse is moved.
\param where The new location of the mouse in the control's coordinate system.
\param code One of the following:
- \c B_ENTERED_VIEW The cursor has just entered the control.
- \c B_INSIDE_VIEW The cursor is inside the control.
- \c B_EXITED_VIEW The cursor has left the control's bounds. This only gets
sent if the scope of the mouse events that the control can receive has
been expanded by BView::SetEventMask() or BView::SetMouseEventMask().
- \c B_OUTSIDE_VIEW The cursor is outside the view. This only gets sent if the
scope of the mouse events that the control can receive has been expanded
by SetEventMask() or SetMouseEventMask().
\param dragMessage If a drag-and-drop operation is taking place this is a
pointer to a BMessage that holds the drag information, otherwise the
pointer is \c NULL.
\sa BView::MouseMoved()
\copydetails BView::MouseMoved()
*/
/*!
\fn void BControl::MouseUp(BPoint where)
\brief Hook method called when a mouse button is released.
\copydetails BView::MouseUp()
*/
/*!
\fn void BControl::SetLabel(const char *label)
\brief Sets the \a label of the control.
@ -306,6 +314,8 @@
If the \a label changes the control is redrawn.
\param label The \a label to set, can be \c NULL.
\since BeOS R3
*/
@ -314,6 +324,8 @@
\brief Gets the label of the control.
\return The control's label.
\since BeOS R3
*/
@ -326,6 +338,8 @@
\param value The \a value to set.
\sa SetValueNoUpdate()
\since BeOS R3
*/
@ -333,11 +347,11 @@
\fn void BControl::SetValueNoUpdate(int32 value)
\brief Sets the value of the control without redrawing.
\note This method was not available in BeOS R5.
\param value The \a value to set.
\sa SetValue()
\since Haiku R1
*/
@ -346,6 +360,8 @@
\brief Gets the value of the control.
\return The control's value.
\since BeOS R3
*/
@ -364,6 +380,8 @@
keyboard or mouse events.
\param enabled If \c true enables the control, if \c false, disables it.
\since BeOS R3
*/
@ -372,6 +390,8 @@
\brief Gets whether or not the control is currently enabled.
\return \c true if the control is enabled, \c false if it is disabled.
\since BeOS R3
*/
@ -387,6 +407,8 @@
\param[out] _height Pointer to a \c float to hold the height of the control.
\sa BView::GetPreferredSize()
\since BeOS R3
*/
@ -395,6 +417,8 @@
\brief Resize the control to its preferred size.
\sa BView::ResizeToPreferred()
\since BeOS R3
*/
@ -418,15 +442,15 @@
\sa BInvoker::Invoke()
\sa IsEnabled()
\since BeOS R3
*/
/*!
\fn BHandler* BControl::ResolveSpecifier(BMessage* message, int32 index,
BMessage* specifier, int32 what, const char* property)
\brief Determine the proper specifier for scripting messages.
\sa BHandler::ResolveSpecifier()
\copydoc BHandler::ResolveSpecifier()
*/
@ -436,36 +460,13 @@
Adds the string "suite/vnd.Be-control" to the message.
\param message Allows you to add the names of the suites the control
implements to the suites array.
\return \c B_OK if all went well or an error code otherwise.
\sa BHandler::GetSupportedSuites();
\copydetails BHandler::GetSupportedSuites();
*/
/*!
\fn status_t BControl::Perform(perform_code code, void* _data)
\brief Perform some action. (Internal Method)
The following perform codes are recognized:
- \c PERFORM_CODE_MIN_SIZE
- \c PERFORM_CODE_MAX_SIZE
- \c PERFORM_CODE_PREFERRED_SIZE
- \c PERFORM_CODE_LAYOUT_ALIGNMENT
- \c PERFORM_CODE_HAS_HEIGHT_FOR_WIDTH
- \c PERFORM_CODE_GET_HEIGHT_FOR_WIDTH
- \c PERFORM_CODE_SET_LAYOUT
- \c PERFORM_CODE_INVALIDATE_LAYOUT
- \c PERFORM_CODE_DO_LAYOUT
\param code The perform code.
\param _data A pointer to store some data.
\returns A status code.
\sa BHandler::Perform()
\copydoc BView::Perform()
*/
@ -477,8 +478,6 @@
It also supports cropping the icon to its non-transparent area.
The icon is meant as an addition to or replacement of the label.
\note This method was not available in BeOS R5.
\param icon The \a icon to set.
\param flags Modify how the icon is set.
- \c B_TRIM_ICON_BITMAP Crop the bitmap to the not fully transparent
@ -490,6 +489,8 @@
- \c B_CREATE_DISABLED_ICON_BITMAPS
\return \c B_OK if the icon was set or an error code otherwise.
\since Haiku R1
*/
@ -500,12 +501,12 @@
partially on, each enabled or disabled, plus up to 125
custom states) can be set individually.
\note This method was not available in BeOS R5.
\param bitmap The \a bitmap icon to set.
\param which The state to set the icon for.
\param flags Modify how the icon is set.
- \c B_KEEP_ICON_BITMAP Transfer ownership of the bitmap to the control.
\return \c B_OK if the icon was set or an error code otherwise.
*/
\since Haiku R1
*/

28
docs/user/interface/Dragger.dox
View File

@ -46,6 +46,8 @@
The Show Replicants/Hide Replicants menu item in Deskbar shows and hides the
BDragger handles.
\since BeOS R3
*/
@ -78,6 +80,8 @@
resized. See BView for more information on resizing options.
\param flags The flags mask sets what notifications the BDragger can
receive. See BView for more information on \a flags.
\since BeOS R3
*/
@ -86,6 +90,8 @@
\brief Constructs a BDragger object from message \a data.
\param data The message \a data to restore from.
\since BeOS R3
*/
@ -93,6 +99,8 @@
\fn BDragger::~BDragger()
\brief Destroys the BDragger object and frees the memory it uses,
primarily from the bitmap handle.
\since BeOS R3
*/
@ -102,6 +110,8 @@
\returns A newly created BDragger or \c NULL if the message doesn't
contain an archived BDragger object.
\since BeOS R3
*/
@ -115,6 +125,8 @@
\returns A status code, typically \c B_OK or \c B_ERROR on error.
\see BView::Archive()
\since BeOS R3
*/
@ -122,6 +134,8 @@
\fn void BDragger::AttachedToWindow()
\brief Puts the BDragger under the control of HideAllDraggers() and
ShowAllDraggers().
\since BeOS R3
*/
@ -129,6 +143,8 @@
\fn void BDragger::DetachedFromWindow()
\brief Removes the BDragger from the control of HideAllDraggers()
and ShowAllDraggers().
\since BeOS R3
*/
@ -137,6 +153,8 @@
\brief Draws the dragger handle.
\param updateRect The rectangular area to draw the handle in.
\since BeOS R3
*/
@ -150,6 +168,8 @@
\param point The point on the screen where to mouse pointer is when
the mouse is clicked.
\since BeOS R3
*/
@ -160,6 +180,8 @@
\param msg The message received
\see BView::MessageReceived()
\since BeOS R3
*/
@ -171,6 +193,8 @@
method.
\returns A status code, \c B_OK on success or an error code on failure.
\since BeOS R3
*/
@ -182,6 +206,8 @@
method.
\returns A status code, \c B_OK on success or an error code on failure.
\since BeOS R3
*/
@ -190,4 +216,6 @@
\brief Returns whether or not draggers are currently drawn.
\returns \c true if draggers are drawn, \c false otherwise.
\since BeOS R3
*/

344
docs/user/interface/Font.dox
View File

File diff suppressed because it is too large Load Diff

20
docs/user/interface/GraphicsDefs.dox
View File

@ -24,6 +24,8 @@
\ingroup interface
\ingroup libbe
\brief A pattern to use when drawing.
\since BeOS R3
*/
@ -31,6 +33,8 @@
\var B_SOLID_HIGH
Draw using the view's high color.
\since BeOS R3
*/
@ -38,6 +42,8 @@
\var B_MIXED_COLORS
Draw a pattern of the view's high and low colors.
\since BeOS R3
*/
@ -45,6 +51,8 @@
\var B_SOLID_LOW
Draw using the view's low color.
\since BeOS R3
*/
@ -53,6 +61,8 @@
\ingroup interface
Blending alpha mode constants.
\since BeOS R3
*/
@ -60,6 +70,8 @@
\var source_alpha B_PIXEL_ALPHA
Use the alpha value of each pixel when drawing a bitmap.
\since BeOS R3
*/
@ -67,6 +79,8 @@
\var source_alpha B_CONSTANT_ALPHA
Use the alpha channel of the view's high color.
\since BeOS R3
*/
@ -75,6 +89,8 @@
\ingroup interface
Blending alpha function constants.
\since BeOS R3
*/
@ -82,6 +98,8 @@
\var alpha_function B_ALPHA_OVERLAY
Used for drawing a image with transparency over an opaque background.
\since BeOS R3
*/
@ -90,4 +108,6 @@
Used to composite two or more transparent images together offscreen to
produce a new image drawn using \c B_ALPHA_OVERLAY mode.
\since BeOS R3
*/

74
docs/user/interface/GridLayout.dox
View File

@ -33,14 +33,18 @@
starting in the top-left.
\warning This class is not yet finalized, if you use it in your software
assume that it will break some time in the future.
assume that it will break some time in the future.
\since Haiku R1
*/
/*!
\fn BGridLayout::BGridLayout(float horizontal = 0.0f, float vertical = 0.0f)
\brief Create a BGridLayout with \a horizontal space between columns and
\a vertical space between rows.
\a vertical space between rows.
\since Haiku R1
*/
@ -49,6 +53,8 @@
\brief Archive constructor.
\param from The message to build the BGridLayout from.
\since Haiku R1
*/
@ -57,6 +63,8 @@
\brief Destructor method.
Standard Destructor.
\since Haiku R1
*/
@ -65,6 +73,8 @@
\brief Returns the number of active columns in this layout.
\returns The number of active columns in the layout.
\since Haiku R1
*/
@ -73,6 +83,8 @@
\brief Returns the number of active rows in this layout.
\returns the number of active rows in the layout.
\since Haiku R1
*/
@ -81,6 +93,8 @@
\brief Returns the spacing between columns for this layout.
\returns The spacing between columns for the layout.
\since Haiku R1
*/
@ -89,6 +103,8 @@
\brief Returns the spacing between rows for this layout.
\returns The spacing between rows for the layout.
\since Haiku R1
*/
@ -97,6 +113,8 @@
\brief Set the spacing between columns for this layout.
\param spacing The number of pixels of spacing to set.
\since Haiku R1
*/
@ -105,6 +123,8 @@
\brief Set the spacing between rows for this layout.
\param spacing The number of pixels of spacing to set.
\since Haiku R1
*/
@ -114,6 +134,8 @@
\param horizontal The number of \a horizontal pixels of spacing to set.
\param vertical The number of \a vertical pixels of spacing to set.
\since Haiku R1
*/
@ -122,6 +144,8 @@
\brief Returns the weight for the specified \a column.
\returns The \a column weight as a float.
\since Haiku R1
*/
@ -131,6 +155,8 @@
\param column The column to set.
\param weight The weight to set.
\since Haiku R1
*/
@ -141,6 +167,8 @@
\param column The column to get the minimum width of.
\returns The minimum width for \a column as a float.
\since Haiku R1
*/
@ -150,6 +178,8 @@
\param column The \a column to set the minimum width of.
\param width The \a width to set.
\since Haiku R1
*/
@ -160,6 +190,8 @@
\param column The column to get the maximum width of.
\returns The maximum width for \a column as a float.
\since Haiku R1
*/
@ -169,6 +201,8 @@
\param column The column to set the maximum width of.
\param width The \a width to set.
\since Haiku R1
*/
@ -177,39 +211,51 @@
\brief Returns the weight of the specified \a row.
\returns The weight of the \a row.
\since Haiku R1
*/
/*!
\fn void BGridLayout::SetRowWeight(int32 row, float weight)
\brief Set the weight for \a row to \a weight.
\brief Set the weight of \a row to \a weight.
\param row The \a row number.
\param weight The \a
\param weight The \a weight to set.
\since Haiku R1
*/
/*!
\fn float BGridLayout::MinRowHeight(int row) const
\brief Returns the minimum height for \a row.
\since Haiku R1
*/
/*!
\fn void BGridLayout::SetMinRowHeight(int32 row, float height)
\brief Sets the minimum height for \a row to \a width.
\since Haiku R1
*/
/*!
\fn float BGridLayout::MaxRowHeight(int32 row) const
\brief Returns the maximum height for \a row.
\since Haiku R1
*/
/*!
\fn void BGridLayout::SetMaxRowHeight(int32 row, float height)
\brief Sets the maximum height for \a row to \a width.
\since Haiku R1
*/
@ -217,12 +263,16 @@
\fn BLayoutItem* BGridLayout::AddView(BView* child)
\brief Adds \a child to this layout in the first empty cell available, or
in a new column in the first row if there are no emtpy cells.
\since Haiku R1
*/
/*!
\fn BLayoutItem* BGridLayout::AddView(int32 index, BView* child);
\brief BGridLayout::AddView(BView*)
\since Haiku R1
*/
@ -230,18 +280,22 @@
\fn BLayoutItem* BGridLayout::AddView(BView* child, int32 column, int32 row,
int32 columnCount = 1, int32 rowCount = 1);
\brief Adds \a child to this layout at \a column and \a row. \a child may
also occupy additional cells if \a columnCount or \a rowCount are
greater than \c 1.
also occupy additional cells if \a columnCount or \a rowCount are
greater than \c 1.
Fails and returns NULL if the requested area is occupied, or if internal
memory allocations fail.
\since Haiku R1
*/
/*!
\fn BLayoutItem* BGridLayout::AddItem(BLayoutItem* item)
\brief Adds \a item to this layout in the first empty cell available, or
in a new column in the first row if there are no emtpy cells.
in a new column in the first row if there are no emtpy cells.
\since Haiku R1
*/
@ -255,9 +309,11 @@
\fn BLayoutItem* BGridLayout::AddItem(BLayoutItem* item, int32 column,
int32 row, int32 columnCount = 1, int32 rowCount = 1);
\brief Adds \a item to this layout at \a column and \a row. \a item may
also occupy additional cells if \a columnCount or \a rowCount are
greater than 1.
also occupy additional cells if \a columnCount or \a rowCount are
greater than 1.
Fails and returns \c NULL if the requested area is occupied, or if internal
memory allocations fail.
\since Haiku R1
*/

61
docs/user/interface/GroupLayout.dox
View File

@ -20,7 +20,8 @@
*/
/*! \class BGroupLayout
/*!
\class BGroupLayout
\ingroup interface
\ingroup layout
\ingroup libbe
@ -47,7 +48,9 @@
will be distributed to other items.
\warning This class is not yet finalized, if you use it in your software
assume that it will break some time in the future.
assume that it will break some time in the future.
\since Haiku R1
*/
@ -57,6 +60,8 @@
\param orientation The orientation of this BGroupLayout.
\param spacing The spacing between BLayoutItems in this BGroupLayout.
\since Haiku R1
*/
@ -65,6 +70,8 @@
\brief Destructor method.
Standard Destructor.
\since Haiku R1
*/
@ -73,53 +80,70 @@
\brief Archive constructor.
\param from The message to construct the BGroupLayout from.
\since Haiku R1
*/
/*!
\fn float BGroupLayout::Spacing() const
\brief Get the amount of spacing (in pixels) between each item.
\since Haiku R1
*/
/*!
\fn void BGroupLayout::SetSpacing(float spacing)
\brief Set the amount of spacing (in pixels) between each item.
\since Haiku R1
*/
/*!
\fn orientation BGroupLayout::Orientation() const
\brief Get the #orientation of this BGroupLayout.
\since Haiku R1
*/
/*!
\fn void BGroupLayout::SetOrientation(orientation orientation)
\brief Set the #orientation of this BGroupLayout.
\param orientation The new #orientation of this BGroupLayout.
\since Haiku R1
*/
/*!
\fn float BGroupLayout::ItemWeight(int32 index) const
\brief Get the weight of the item at \a index.
\since Haiku R1
*/
/*!
\fn void BGroupLayout::SetItemWeight(int32 index, float weight)
\brief Set the weight of the item at \a index.
\since Haiku R1
*/
/*!
\fn BLayoutItem* BGroupLayout::AddView(BView* child)
\brief Adds \a child to this layout as the last item. In a vertical
BGroupLayout, \a child will be on the right, in a horizontal
BGroupLayout, \a child will be at the bottom.
BGroupLayout, \a child will be on the right, in a horizontal
BGroupLayout, \a child will be at the bottom.
\a child will have a weight of \c 1.0f.
\since Haiku R1
*/
@ -128,6 +152,8 @@
\brief Adds \a child to this layout at \a index.
\a child will have a weight of \c 1.0f.
\since Haiku R1
*/
@ -135,24 +161,30 @@
\fn BLayoutItem* BGroupLayout::AddView(BView* child, float weight)
\brief Adds \a child to the end of this layout with a weight of
\a weight.
\since Haiku R1
*/
/*!
\fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child,
\fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child,
float weight)
\brief Adds \a child this layout at \a index with a weight of
\a weight.
\a weight.
\since Haiku R1
*/
/*!
\fn bool BGroupLayout::AddItem(BLayoutItem* item)
\brief Adds \a item to this layout as the last item. In a vertical
BGroupLayout, \a item will be on the right, in a horizontal
BGroupLayout, \a item will be at the bottom.
BGroupLayout, \a item will be on the right, in a horizontal
BGroupLayout, \a item will be at the bottom.
\a item will have a weight of \c 1.0f.
\since Haiku R1
*/
@ -161,18 +193,25 @@
\brief Adds \a item to this layout at \a index.
\a item will have a weight of \c 1.0f.
\since Haiku R1
*/
/*!
\fn bool BGroupLayout::AddItem(BLayoutItem* item, float weight)
\brief Adds \a item to the end of this layout with a weight of
\a weight.
\a weight.
\since Haiku R1
*/
/*!
\fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item, float weight)
\fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item,
float weight)
\brief Adds \a item this layout at \a index with a weight of
\a weight.
\a weight.
\since Haiku R1
*/

18
docs/user/interface/IconUtils.dox
View File

@ -36,6 +36,8 @@
older icons in bitmap format. These may still be useful at very small
sizes. Note you can't create an instance of BIconUtils, just call the
static methods.
\since Haiku R1
*/
@ -52,6 +54,8 @@
\note If the colorspace is B_CMAP8, B_CMAP8 icons are preferred. In that
case, the bitmap size must also match the provided icon_size "size"!
\since Haiku R1
*/
@ -70,6 +74,8 @@
\note The scale is derived from the bitmap width, the bitmap should have
square dimension, or the icon will be cut off at the bottom (or have
room left).
\since Haiku R1
*/
@ -88,6 +94,8 @@
\note The scale is derived from the bitmap width, the bitmap should have
square dimension, or the icon will be cut off at the bottom (or have
room left).
\since Haiku R1
*/
@ -101,6 +109,8 @@
either the small icon attribute or the large icon attribute as given in
\a smallIconAttrName and \a largeIconAttrName. Which icon is loaded depends
on the given \a size.
\since Haiku R1
*/
@ -113,6 +123,8 @@
BBitmap \a result
\note result should be in B_RGBA32 colorspace, and source in B_CMAP8.
\since Haiku R1
*/
@ -126,6 +138,8 @@
old-style icon.
\note result should be in B_CMAP8 colorspace, and source in B_RGBA32.
\since Haiku R1
*/
@ -133,6 +147,8 @@
\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.
\since Haiku R1
*/
@ -140,4 +156,6 @@
\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.
\since Haiku R1
*/

60
docs/user/interface/InterfaceDefs.dox
View File

@ -16,6 +16,8 @@
\ingroup interface
\ingroup libbe
\brief Defines standard interface definitions for controls.
\since BeOS R3
*/
@ -24,6 +26,8 @@
\ingroup interface
Collection of flags that determine the border style drawn around a BBox.
\since BeOS R3
*/
@ -35,6 +39,8 @@
The right and bottom sides of the box are darker than the top and
left sides to produce a shadow effect and make the box look like it
is raised slightly above the surrounding surface.
\since BeOS R3
*/
@ -45,6 +51,8 @@
The border is a bevelled to give it a 3D effect. The border is uniform
in appearance on all four sides. This is the default appearance.
\since BeOS R3
*/
@ -52,6 +60,8 @@
\var border_style B_NO_BORDER
No border.
\since BeOS R3
*/
@ -60,6 +70,8 @@
Orientation flag sets the layout to either horizontal or vertical
alignment.
\since BeOS R3
*/
@ -69,11 +81,15 @@
Horizontal alignment
*/
\since BeOS R3
/*!
\var orientation B_VERTICAL
Vertical alignment
\since BeOS R3
*/
@ -82,6 +98,8 @@
Collection of flags that determine how wide to draw the buttons in a
BAlert dialog.
\since BeOS R3
*/
@ -89,6 +107,8 @@
\var button_width B_WIDTH_AS_USUAL
Set the width of each button based on the standard width.
\since BeOS R3
*/
@ -96,6 +116,8 @@
\var button_width B_WIDTH_FROM_WIDEST
Set the width of each button based on the width of the widest button.
\since BeOS R3
*/
@ -104,6 +126,8 @@
Set the width of each button to accomidate the width of the button's
label.
\since BeOS R3
*/
@ -114,6 +138,8 @@
\enum join_mode
PostScript-style line join modes used by BView::SetLineMode()
\since BeOS R3
*/
@ -121,6 +147,8 @@
\var join_mode B_ROUND_JOIN
Round join mode.
\since BeOS R3
*/
@ -128,6 +156,8 @@
\var join_mode B_MITER_JOIN
Miter join mode.
\since BeOS R3
*/
@ -135,6 +165,8 @@
\var join_mode B_BEVEL_JOIN
Bevel join mode.
\since BeOS R3
*/
@ -142,12 +174,16 @@
\var join_mode B_BUTT_JOIN
Butt join mode.
\since BeOS R3
*/
/*!
\var join_mode B_SQUARE_JOIN
Square join mode.
\since BeOS R3
*/
@ -155,6 +191,8 @@
\enum cap_mode
PostScript-style line cap modes used by BView::SetLineMode()
\since BeOS R3
*/
@ -162,6 +200,8 @@
\var cap_mode B_ROUND_CAP
Round cap mode.
\since BeOS R3
*/
@ -169,6 +209,8 @@
\var cap_mode B_BUTT_CAP
Butt cap mode.
\since BeOS R3
*/
@ -176,6 +218,8 @@
\var cap_mode B_SQUARE_CAP
Square cap mode.
\since BeOS R3
*/
@ -183,6 +227,8 @@
\var B_DEFAULT_MITER_LIMIT
Default miter limit used to calculate the angle cut off for miter joins.
\since BeOS R3
*/
@ -218,6 +264,8 @@
- \c B_RIGHT_COMMAND_KEY
\returns A bitmap containing each active modifier keys and locks.
\since BeOS R3
*/
@ -230,6 +278,8 @@
\retval B_OK Everything went fine.
\retval B_ERROR There was an error retrieving the key_info struct.
\since BeOS R3
*/
@ -242,6 +292,8 @@
\param _map A pointer to the system keymap structure.
\param _keyBuffer A pointer containing the UTF-8 character encodings.
\since BeOS R3
*/
@ -251,6 +303,8 @@
\retval B_OK Everything went fine.
\retval B_ERROR There was an error retrieving the keyboard id.
\since BeOS R3
*/
@ -264,6 +318,8 @@
\retval B_OK Everything went fine.
\retval B_ERROR There was an error retrieving the modifier key.
\since BeOS R3
*/
@ -274,6 +330,8 @@
\param modifier The modifier key to set in the system keymap.
\param key The key code to set the modifier key to.
\since BeOS R3
*/
@ -290,4 +348,6 @@
absent will turn the lock off. Pass 0 in to turn off all locks.
\param modifiers A bitmap of lock keys to set.
\since BeOS R3
*/

220
docs/user/interface/Layout.dox
View File

@ -28,8 +28,8 @@
\brief The BLayout class provides an interface, and some basic
implementation to manage the positioning and sizing of BLayoutItem s.
BLayouts can be attached to a BView, managing the BLayoutItem&apos;s and
BView&apos;s that reside in that view, or can be nested within another
BLayouts can be attached to a BView, managing the BLayoutItem's and
BView's that reside in that view, or can be nested within another
BLayout as a BLayoutItem.
Before adding a BLayoutItem to a BLayout, that layout must have a target
@ -39,7 +39,7 @@
target of the layout it's nested in, if it does not have a target already.
You can retrieve the target view for a layout with the TargetView() method.
When adding a BLayoutItem to a BLayout, the item's view (as returned by
BLayoutItem::View()) is added to the BLayout&apos;s target view.
BLayoutItem::View()) is added to the BLayout's target view.
\code
BView* topView = new BGroupView();
@ -67,6 +67,8 @@ topLayout->AddItem(nestedLayoutWithView);
\warning This class is not yet finalized, if you use it in your software
assume that it will break some time in the future.
\since Haiku R1
*/
@ -75,10 +77,12 @@ topLayout->AddItem(nestedLayoutWithView);
\brief Default constructor.
After this constructor has finished, this BLayout holds no
BLayoutItem&apos;s and does not have a target BView.
BLayoutItem's and does not have a target BView.
\warning Because a new BLayout does not have a target BView, calls to the
AddItem() and AddView() will fail methods will fail.
\since Haiku R1
*/
@ -87,24 +91,28 @@ topLayout->AddItem(nestedLayoutWithView);
\brief Archive constructor.
\param archive The archive message.
\since Haiku R1
*/
/*!
\fn BLayout::~BLayout()
\brief Destructor, deletes all BLayoutItem&apos;s that this layout manages,
and detaches from this BLayout&apos;s owner view if there is one.
\brief Destructor, deletes all BLayoutItem's that this layout manages,
and detaches from this BLayout's owner view if there is one.
Each BLayoutItem&apos;s BView (as returned by BLayoutItem::View()) is also
Each BLayoutItem's BView (as returned by BLayoutItem::View()) is also
removed from their parent.
\note Because nested BLayout&apos;s are treated as BLayoutItem&apos;s,
\note Because nested BLayout's are treated as BLayoutItem's,
any layouts nested in this BLayout will be deleted.
\since Haiku R1
*/
/*!
\name BView targeting and attachment information.
\name BView Targeting and Attachment Information
*/
@ -114,6 +122,8 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\fn BView* BLayout::Owner() const
\brief Returns the Owner of this layout, i.e. the view this layout manages.
\since Haiku R1
*/
@ -121,9 +131,11 @@ topLayout->AddItem(nestedLayoutWithView);
\fn BView* BLayout::TargetView() const
\brief Returns the target view of this layout.
The target view of a layout becomes the parent of any BView&apos;s in this
layout, as well as the BView&apos;s returned by BLayoutItem::View() for
The target view of a layout becomes the parent of any BView's in this
layout, as well as the BView's returned by BLayoutItem::View() for
each BLayoutItem in this layout.
\since Haiku R1
*/
@ -131,6 +143,8 @@ topLayout->AddItem(nestedLayoutWithView);
\fn BView* BLayout::View()
\brief Returns the same BView* as BLayout::Owner(), this method is
inherited from BLayoutItem.
\since Haiku R1
*/
@ -138,7 +152,7 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\name Adding, removing, counting and accessing BLayout children
\name Adding, Removing, Counting and Accessing Children
*/
@ -149,38 +163,44 @@ topLayout->AddItem(nestedLayoutWithView);
\fn BLayoutItem* BLayout::AddView(BView* child)
\brief Creates a BLayoutItem to represent a BView, and adds that item to
this layout.
\a child is added to this BLayout&apos;s target view.
\a child is added to this BLayout's target view.
\returns The BLayoutItem created to represent \a child is, or \c NULL if
there was an error.
\param child The BView to be added to this BLayout.
\since Haiku R1
*/
/*!
\fn BLayoutItem* BLayout::AddView(int32 index, BView* child)
\fn BLayoutItem* BLayout::AddView(int32 index, BView* child)
\brief Creates a BLayoutItem to represent \a child, and adds that item at
\a index to this layout. \a child is added to this BLayout&apos;s target view.
\a index to this layout. \a child is added to this BLayout's target view.
\since Haiku R1
*/
/*!
\fn bool BLayout::AddItem(BLayoutItem* item)
\brief Adds a BLayoutItem to this layout, and adds the BView it represents
to this BLayout&apos;s target view.
to this BLayout's target view.
\param item The BLayoutItem to be added.
\retval true success
\retval false failure
\return \c true if the item was added, \c false otherwise.
\since Haiku R1
*/
/*!
\fn bool BLayout::AddItem(int32 index, BLayoutItem* item)
\brief Adds \a item to this layout, and adds the BView \a item represents
to this BLayout&apos;s target view.
to this BLayout's target view.
\param item The BLayoutItem to be added.
\param index The index at which to add \c item.
@ -189,27 +209,29 @@ topLayout->AddItem(nestedLayoutWithView);
is somewhere between the first and last indices, then items from \a index
to the end will be shuffled over by one.
\retval true success
\retval false failure
\return \c true if the item was added, \c false otherwise.
\since Haiku R1
*/
/*!
\fn bool BLayout::RemoveView(BView* child)
\brief Removes and deletes all BLayoutItem representing a BView from
this layout.
this layout.
\param child The BView to be removed.
\retval true success
\retval false failure
\return \c true if the item was removed, \c false otherwise.
\since Haiku R1
*/
/*!
\fn bool BLayout::RemoveItem(BLayoutItem* item)
\brief Removes a BLayoutItem from this layout, and also removes the view
it represents from this BLayout&apos;s target view.
\brief Removes a BLayoutItem from this layout, and also removes the view
it represents from this BLayout's target view.
\param item The BLayoutItem to be removed
@ -218,8 +240,9 @@ topLayout->AddItem(nestedLayoutWithView);
\warning \a item->View(), even when it is removed from the target view,
is not deleted. If you want it deleted, you must delete it yourself!
\retval true success
\retval false failure
\return \c true if the item was removed, \c false otherwise.
\since Haiku R1
*/
@ -230,19 +253,25 @@ topLayout->AddItem(nestedLayoutWithView);
\see RemoveItem(BLayoutItem*)
\returns The BLayoutItem that was removed.
\since Haiku R1
*/
/*!
\fn BLayoutItem* BLayout::ItemAt(int32 index) const
\brief Get the BLayoutItem at \a index. Returns \c NULL if \a index is
out of bounds.
out of bounds.
\since Haiku R1
*/
/*!
\fn int32 BLayout::CountItems() const
\brief Get the number of BLayoutItem s in this layout.
\since Haiku R1
*/
@ -253,6 +282,8 @@ topLayout->AddItem(nestedLayoutWithView);
\param item The BLayoutItem whose index you want.
\retval -1 \a item was not found in this BLayout.
\since Haiku R1
*/
@ -263,6 +294,8 @@ topLayout->AddItem(nestedLayoutWithView);
\note This finds the index of views added through BLayout::AddView(), not
the index of an item which represents \a child that was added through
BLayout::AddItem().
\since Haiku R1
*/
@ -270,9 +303,10 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\name Subclass helpers.
\brief These methods are meant to ease the development of BLayout
subclasses.
\name Subclass Helpers
These methods are meant to ease the development of BLayout
subclasses.
*/
@ -285,9 +319,11 @@ topLayout->AddItem(nestedLayoutWithView);
If a BLayout is connected to a BView, this will always return \c true.
If a BLayout is nested in another layout (it was passed to AddItem()), then
this will reflect the visibility of this BLayout&apos;s parent layout. If
this will reflect the visibility of this BLayout's parent layout. If
any layout is hidden (by BLayout::SetVisible()) between this layout and its
target BView&apos;s layout, then this method will return \c false.
target BView's layout, then this method will return \c false.
\since Haiku R1
*/
@ -296,9 +332,11 @@ topLayout->AddItem(nestedLayoutWithView);
\brief Returns the on-screen area this layout has received to lay out its
items in.
The return value is in the coordinate space of this BLayout&apos;s target
The return value is in the coordinate space of this BLayout's target
view. If this BLayout is attached directly to a BView, then
<tt> LayoutArea().LeftTop() == B_ORIGIN </tt>.
\since Haiku R1
*/
@ -309,6 +347,8 @@ topLayout->AddItem(nestedLayoutWithView);
BLayout.
\param show \c true to show, \c false to hide.
\since Haiku R1
*/
@ -316,7 +356,7 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\name Methods triggering or related to laying out this BLayout.
\name Methods Triggering or Related to Laying Out the BLayout
*/
@ -330,24 +370,28 @@ topLayout->AddItem(nestedLayoutWithView);
If \a immediate is \c false, and there is already a request to have the
window this layout resides in re-laid-out, then the layout will happen at
that time. If \a immediate is \c true, and there is no such pending
request, nor is this BLayout&apos;s parent layout in the process of laying
request, nor is this BLayout's parent layout in the process of laying
out its items, then this BLayout will now layout its items.
\param immediate Whether or not to Relayout immediately or wait for pending
requests first.
requests first.
\since Haiku R1
*/
/*!
\fn void BLayout::LayoutItems(bool force = false)
\brief If there is no layout currently ongoing, and \a force is \c false,
creates a new BLayoutContext and calls the DoLayout() method
of this BLayout and any BLayout s nested in this BLayout.
creates a new BLayoutContext and calls the DoLayout() method
of this BLayout and any BLayout's nested in this BLayout.
This method also guarantees that the owner view of this layout (as returned
by BLayout::Owner()) performs a layout as well (if it is suitable to do so).
\param force Force the LayoutItems.
\since Haiku R1
*/
@ -355,6 +399,8 @@ topLayout->AddItem(nestedLayoutWithView);
\fn BLayoutContext* BLayout::LayoutContext() const
\brief Returns the BLayoutContext this BLayout is currently operating in,
or \c NULL.
\since Haiku R1
*/
@ -362,7 +408,7 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\name Invalidation and state mutators and accessors.
\name Invalidation and State Mutators and Accessors
*/
@ -373,6 +419,8 @@ topLayout->AddItem(nestedLayoutWithView);
\fn void BLayout::RequireLayout()
\brief Flag this layout as stale, i.e. any cached data may still be valid,
but the items need to be repositioned or resized.
\since Haiku R1
*/
@ -382,7 +430,7 @@ topLayout->AddItem(nestedLayoutWithView);
to positioning and sizing of its items.
Invalidating a BLayout also invalidates the view it is connected to
(if there is one) and the BLayout this layout (or this BLayout&apos;s view)
(if there is one) and the BLayout this layout (or this BLayout's view)
resides in.
Although this method is virtual, you should not override it, override the
@ -395,13 +443,18 @@ topLayout->AddItem(nestedLayoutWithView);
\sa BView::InvalidateLayout(), BLayoutItem::InvalidateLayout(),
BLayout::LayoutInvalidated()
\since Haiku R1
*/
/*!
\fn bool BLayout::IsValid()
\brief Returns whether this layout has been invalidated (via
BLayout::InvalidateLayout()) and has not yet been validated (by doing a
layout, or by its ResetLayoutInvalidation() method.
BLayout::InvalidateLayout()) and has not yet been validated
(by doing a layout, or by its ResetLayoutInvalidation() method.
\since Haiku R1
*/
@ -409,21 +462,27 @@ topLayout->AddItem(nestedLayoutWithView);
\fn void BLayout::EnableLayoutInvalidation()
\brief Re-enable layout invalidation after a call to
DisableLayoutInvalidation().
\since Haiku R1
*/
/*!
\fn void BLayout::DisableLayoutInvalidation()
\brief Disable layout invalidation notifications, i.e. calls to
this object's InvalidateLayout() method.
this object's InvalidateLayout() method.
\since Haiku R1
*/
/*!
\fn void BLayout::ResetLayoutInvalidation()
\brief Reset layout invalidation, causing InvalidateLayout calls to proceed
again. This method should be called once any cached data has been
validated, or updated to valid values.
again. This method should be called once any cached data has been
validated, or updated to valid values.
\since Haiku R1
*/
@ -431,9 +490,12 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\name Archiving methods
\brief These methods relate to the archiving or unarchiving of this object
and the BLayoutItem&apos;s it contains
\name Archiving
These methods relate to the archiving or unarchiving of this object
and the BLayoutItem's it contains
\since Haiku R1
*/
@ -443,14 +505,18 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\fn status_t BLayout::Archive(BMessage* archive, bool deep = true) const
\brief Archives this layout into \a archive. If deep is true, also archives
the items in this layout, calling ItemArchived() for each one.
the items in this layout, calling ItemArchived() for each one.
\since Haiku R1
*/
/*!
\fn status_t BLayout::AllUnarchived(const BMessage* from)
\brief Unarchives the BLayoutItem&apos;s for this layout, calling
ItemUnarchived() for each one.
\brief Unarchives the BLayoutItem's for this layout, calling
ItemUnarchived() for each one.
\since Haiku R1
*/
@ -458,10 +524,12 @@ topLayout->AddItem(nestedLayoutWithView);
\fn status_t BLayout::ItemArchived(BMessage* into, BLayoutItem* item,
int32 index) const
\brief Hook for derived classes to add data specific to \a item to the
\a into BMessage. \a item resides at \a index.
\a into BMessage. \a item resides at \a index.
\note The same archive is passed to BLayout::ItemArchived() for all items,
so any data added for each item will be stored in an array.
\since Haiku R1
*/
@ -472,8 +540,11 @@ topLayout->AddItem(nestedLayoutWithView);
the \a from BMessage. \a item resides at \a index.
\note The same archive is passed to BLayout::ItemArchived() for all items,
so any data added for each item will be stored in an array. You should pass
\a index to the BMessage methods you will be using in this method.
so any data added for each item will be stored in an array. You
should pass \a index to the BMessage methods you will be using in
this method.
\since Haiku R1
*/
@ -481,7 +552,7 @@ topLayout->AddItem(nestedLayoutWithView);
/*!
\name BLayout Hook methods
\name Hook Methods
*/
@ -495,11 +566,12 @@ topLayout->AddItem(nestedLayoutWithView);
\param item The BLayoutItem that is being added.
\param atIndex The index of the BLayoutItem.
\retval true success
\retval false failure, \a item will not be added.
\return \c true on succcess, false if \a item will not be added.
\note This is a good time to allocate data for a BLayoutItem and attach it
to \a item via BLayoutItem::SetLayoutData().
\since Haiku R1
*/
@ -517,6 +589,8 @@ topLayout->AddItem(nestedLayoutWithView);
\note This is a good time to delete the data you've attached to \a item
via BLayoutItem::SetLayoutData().
\since Haiku R1
*/
@ -524,6 +598,8 @@ topLayout->AddItem(nestedLayoutWithView);
\fn void BLayout::DoLayout() = 0
\brief Implemented by derived classes to position and resize the items in
this layout.
\since Haiku R1
*/
@ -534,6 +610,8 @@ topLayout->AddItem(nestedLayoutWithView);
to clear any caches your object might hold.
\param children Whether or not child layouts have also been invalidated.
\since Haiku R1
*/
@ -542,33 +620,41 @@ topLayout->AddItem(nestedLayoutWithView);
\brief Hook method called when this layout is attached to a BView.
\param was The previous owner of this BLayout, for new BLayout s, this
will be \c NULL.
will be \c NULL.
\since Haiku R1
*/
/*!
\fn void BLayout::AttachedToLayout()
\brief Hook method inherited from BLayoutItem, classes derived from
BLayout must include the BLayout version of this method in their
implementation.
BLayout must include the BLayout version of this method in their
implementation.
\since Haiku R1
*/
/*!
\fn void BLayout::DetachedFromLayout(BLayout* layout)
\brief Hook method inherited from BLayoutItem, classes derived from
BLayout must include the BLayout version of this method in their
implementation.
BLayout must include the BLayout version of this method in their
implementation.
\param layout The BLayout that this BLayout was detached from.
\since Haiku R1
*/
/*!
\fn void BLayout::AncestorVisibilityChanged(bool shown)
\brief Hook method inherited from BLayoutItem, classes derived from
BLayout must include the BLayout version of this method in their
implementation.
BLayout must include the BLayout version of this method in their
implementation.
\since Haiku R1
*/

107
docs/user/interface/LayoutBuilder.Group.dox
View File

@ -18,6 +18,8 @@
\ingroup layout
\ingroup libbe
\brief Provides the BLayoutBuilder::Group<> class.
\since Haiku R1
*/
@ -27,30 +29,40 @@
\ingroup layout
\ingroup libbe
\brief BLayoutBuilder::Base subclass for building BGroupLayouts.
\since Haiku R1
*/
/*!
\typedef BLayoutBuilder::Group<ParentBuilder>::GroupBuilder
\brief Shorthand for builders returned by this builder's AddGroup() methods.
\since Haiku R1
*/
/*!
\typedef BLayoutBuilder::Group<ParentBuilder>::GridBuilder
\brief Shorthand for builders returned by this builder's AddGrid() methods.
\since Haiku R1
*/
/*!
\typedef BLayoutBuilder::Group<ParentBuilder>::SplitBuilder
\brief Shorthand for builders returned by this builder's AddSplit() methods.
\since Haiku R1
*/
/*!
\typedef BLayoutBuilder::Group<ParentBuilder>::ThisBuilder
\brief Shorthand representing the type of \c this.
\since Haiku R1
*/
@ -68,10 +80,12 @@
\brief Creates a new BGroupLayout, and attaches it to a BWindow.
\note The top BView* in \a window has its ViewColor set to
B_PANEL_BACKGROUND_COLOR.
\c B_PANEL_BACKGROUND_COLOR.
\param window Thew BWindow* to attach the newly created BGroupLayout to.
\param orientation The orientation for the new BGroupLayout.
\param spacing The spacing for the new BGroupLayout.
\since Haiku R1
*/
@ -80,7 +94,10 @@
\brief Creates a builder targeting a BGroupLayout.
Methods called on this builder will be directed to \a layout.
\param layout The BGroupLayout to target with this builder.
\since Haiku R1
*/
@ -92,6 +109,8 @@
\c view->GroupLayout().
\param view The BGroupView this builder will target.
\since Haiku R1
*/
@ -105,6 +124,8 @@
\param orientation The orientation for the new BGroupView.
\param spacing The spacing for the new BGroupView.
\since Haiku R1
*/
@ -124,6 +145,8 @@
\param view The BView to be added.
\see BGroupLayout::AddView(BView*)
\since Haiku R1
*/
@ -134,7 +157,10 @@
\param view The BView to be added.
\param weight The weight to give \a view.
\see BGroupLayout::AddView(BView* view, float weight)
\since Haiku R1
*/
@ -144,7 +170,10 @@
\brief Add a BLayoutItem to the BGroupLayout this builder represents.
\param item The BLayoutItem to be added.
\see BGroupLayout::AddItem(BLayoutItem*)
\since Haiku R1
*/
@ -156,6 +185,8 @@
\param item The BLayoutItem to be added.
\param weight The weight to give \a item.
\see BGroupLayout::AddItem(BLayoutItem* item, float weight)
\since Haiku R1
*/
@ -163,8 +194,9 @@
/*!
\name Adding BLayouts and their BView pairs
\brief A set of methods that add a BLayout or BView subclass and return a
\name Adding BLayouts and their BView Pairs
A set of methods that add a BLayout or BView subclass and return a
BLayoutBuilder::Base subclass representing the newly added object. These
methods push a new builder on top of the stack, you will not be using
\c this builder again until you call End().
@ -178,14 +210,16 @@
\fn GroupBuilder BLayoutBuilder::Group<ParentBuilder>::AddGroup(
orientation orientation, float spacing, float weight)
\brief Construct and add a viewless BGroupLayout, then return a GroupBuilder
representing the newly added layout.
representing the newly added layout.
\param orientation The orientation to use for the new BGroupLayout.
\param spacing The spacing to use for the new BGroupLayout.
\param weight The weight for the new BGroupLayout in the BGroupLayout this
builder represents.
builder represents.
\returns A GroupBuilder representing the newly created BGroupLayout.
\since Haiku R1
*/
@ -193,25 +227,31 @@
\fn GroupBuilder BLayoutBuilder::Group<ParentBuilder>::AddGroup(BGroupView*
groupView, float weight)
\brief Add BGroupView and return a builder representing the newly added
BGroupView.
BGroupView.
\param groupView The BGroupView to be added.
\param weight The weight for \a groupView in the BGroupLayout this builder
represents.
represents.
\returns A GroupBuilder representing \a groupView.
\since Haiku R1
*/
/*!
\fn GroupBuilder BLayoutBuilder::Group<ParentBuilder>::AddGroup(
BGroupLayout* groupLayout, float weight)
\brief Add a BGroupLayout and return a builder representing
the newly added BGroupLayout.
\brief Add a BGroupLayout and return a builder representing the newly added
BGroupLayout.
\param groupLayout The BGroupLayout to be added.
\param weight The weight for \a groupLayout in the BGroupLayout this builder
represents.
\returns A GroupBuilder representing \a groupLayout.
\since Haiku R1
*/
@ -220,35 +260,39 @@
float horizontalSpacing = 0.0f, float verticalSpacing = 0.0f,
float weight = 1.0f)
\brief Create and add a viewless BGridLayout, then return a builder
representing the newly created BGridLayout.
representing the newly created BGridLayout.
\param horizontalSpacing The horizontal spacing for the new BGridLayout.
\param verticalSpacing The vertical spacing for the new BGridLayout.
\param weight The weight for the new BGroupLayout in the BGroupLayout this
builder represents.
\returns A GridBuilder representing the newly created BGridLayout.
\since Haiku R1
*/
/*!
\fn GridBuilder BLayoutBuilder::Group<ParentBuilder>::AddGrid(
BGridLayout* gridLayout, float weight = 1.0f)
\brief Add a BGridLayout, then return a builder the newly added
BGridLayout.
\brief Add a BGridLayout, then return a builder the newly added BGridLayout.
\param gridLayout The BGridLayout to be added and used to construct the
returned GridBuilder.
\param weight The weight for \a groupLayout in the BGroupLayout this builder
represents.
\returns a GridBuilder representing \a gridLayout.
\since Haiku R1
*/
/*!
\fn GridBuilder BLayoutBuilder::Group<ParentBuilder>::AddGrid(
BGridView* gridView, float weight = 1.0f)
\brief Add a BGridView, then return a builder the newly added
BGridView.
\brief Add a BGridView, then return a builder the newly added BGridView.
\param gridView The BGridView to be added and used to construct the
returned GridBuilder.
@ -256,13 +300,14 @@
represents.
\returns a GridBuilder representing \a gridView.
\since Haiku R1
*/
/*!
\fn SplitBuilder BLayoutBuilder::Group<ParentBuilder>::AddSplit(
orientation orientation, float spacing, float weight)
\brief Create and add a new BSplitView with a weight of \c weight, then
return a SplitBuilder representing the new BSplitView.
@ -271,6 +316,8 @@
\param weight The weight, in this BGroupLayout for the new BSplitView.
\returns a SplitBuilder representing the new BSplitView.
\since Haiku R1
*/
@ -283,6 +330,8 @@
\param splitView The BSplitView to be added.
\param weight The weight of the BSplitView in the BGroupLayout this builder
represents.
\since Haiku R1
*/
@ -291,6 +340,7 @@
/*!
\name Adding BSpaceLayoutItems
Some convenience methods for adding special BSpaceLayoutItems.
*/
@ -306,18 +356,22 @@
\param weight The weight of the BSpaceLayoutItem in the BGroupLayout this
builder represents
\since Haiku R1
*/
/*!
\fn ThisBuilder& BLayoutBuilder::Group<ParentBuilder>::AddStrut(float size)
\brief Add a BSpaceLayoutItem created by
BSpaceLayoutItem::CreateHorizontalStrut() or
BSpaceLayoutItem::CreateVerticalStrut() to the BGroupLayout this builder
represents.
BSpaceLayoutItem::CreateHorizontalStrut() or
BSpaceLayoutItem::CreateVerticalStrut() to the BGroupLayout
this builder represents.
\param size The width or height of the strut to be created (depending on
the orientation of the BGroupLayout this builder represents).
\since Haiku R1
*/
@ -329,6 +383,8 @@
float top, float right, float bottom)
\brief Call the BTwoDimensionalLayout::SetInsets() method on the
BGroupLayout this builder represents.
\since Haiku R1
*/
@ -343,12 +399,16 @@
/*!
\fn BGroupLayout* BLayoutBuilder::Group<ParentBuilder>::Layout() const
\brief Get the BGroupLayout this builder represents.
\since Haiku R1
*/
/*!
\fn BView* BLayoutBuilder::Group<ParentBuilder>::View() const
\brief Get the BView this builder's BGroupLayout is attached to.
\since Haiku R1
*/
@ -356,21 +416,30 @@
\fn ThisBuilder& BLayoutBuilder::Group<ParentBuilder>::GetLayout(
BGroupLayout** _layout)
\brief Get the BGroupLayout this builder represents.
\param[out] _layout The BGroupLayout this builder represents.
\since Haiku R1
*/
/*!
\fn ThisBuilder& BLayoutBuilder::Group<ParentBuilder>::GetView(
BView** _view)
BView** _view)
\brief Get the BView this builder's BGroupLayout is attached to.
\param[out] _view The BView this builder's BGroupLayout is attached to.
\since Haiku R1
*/
/*!
\fn BLayoutBuilder::Group<ParentBuilder>::operator BGroupLayout*()
\brief Cast this builder into the BGroupLayout it represents.
\since Haiku R1
*/
//!@}

10
docs/user/interface/LayoutBuilder.dox
View File

@ -89,20 +89,26 @@ BLayoutBuilder::Group<>(B_HORIZONTAL)
.End()
// back to the Group<>::GridBuilder
\endcode
\since Haiku R1
*/
/*!
\fn void BLayoutBuilder::Base<ParentBuilder>::SetParent(ParentBuilder*
parent)
Internal method for use by BLayoutBuilder::Base subclasses, this is
essential to the builder stack semantics
\brief Internal method for use by BLayoutBuilder::Base subclasses,
this is essential to the builder stack semantics.
\since Haiku R1
*/
/*!
\fn ParentBuilder& BLayoutBuilder::Base<ParentBuilder>::End()
\brief Returns this builder's parent.
\since Haiku R1
*/

96
docs/user/interface/LayoutItem.dox
View File

@ -34,6 +34,8 @@
\warning This class is not yet finalized, if you use it in your software
assume that it will break some time in the future.
\since Haiku R1
*/
@ -42,12 +44,16 @@
\brief Archive constructor.
Creates a BLayoutItem from the \a archive message.
\since Haiku R1
*/
/*!
\fn BLayout* BLayoutItem::Layout() const
\brief Returns the BLayout this BLayoutItem resides in.
\since Haiku R1
*/
@ -56,11 +62,13 @@
\brief Destructor method.
Standard Destructor.
\since Haiku R1
*/
/*!
\name Reporting size and alignment constraints to a BLayout
\name Reporting Size and Alignment Constraints to a BLayout
*/
@ -70,18 +78,24 @@
/*!
\fn BSize BLayoutItem::MinSize() = 0
\brief Returns the minimum desirable size for this item.
\since Haiku R1
*/
/*!
\fn BSize BLayoutItem::MaxSize() = 0
\brief Returns the maximum desirable size for this item.
\since Haiku R1
*/
/*!
\fn BSize BLayoutItem::PreferredSize() = 0
\brief Returns the preferred size for this item.
\since Haiku R1
*/
@ -94,6 +108,8 @@
for example, although each item recieves the same horizontal area, each item
can use that area differently, aligning to the left, right or center for
example.
\since Haiku R1
*/
@ -103,6 +119,8 @@
dependent on its width.
\note By default, this method returns \c false.
\since Haiku R1
*/
@ -117,6 +135,8 @@
\note It is prudent to compare \a min, \a max, \a preferred to \c NULL
before dereferencing them.
\since Haiku R1
*/
@ -124,7 +144,7 @@
/*!
\name Overriding size constraints and alignment.
\name Overriding Size and Alignment Constraints
Although the explicit constraints placed on an item are not enforced by the
BLayoutItem class, all Haiku BLayoutItem subclasses will use the
@ -132,6 +152,8 @@
in when reporting these constraints. It is recommended that all subclasses
do this as well, the BAbstractLayoutItem class provides any easy way to
include this behaviour in your class.
\since Haiku R1
*/
@ -141,12 +163,16 @@
/*!
\fn void BLayoutItem::SetExplicitMinSize(BSize size) = 0
\brief Set this item's explicit min size, to be used in MinSize().
\since Haiku R1
*/
/*!
\fn void BLayoutItem::SetExplicitMaxSize(BSize size) = 0
\brief Set this item's explicit max size, to be used in MaxSize().
\since Haiku R1
*/
@ -154,12 +180,16 @@
\fn void BLayoutItem::SetExplicitPreferredSize(BSize size) = 0
\brief Set this item's explicit preferred size, to be used in
PreferredSize().
\since Haiku R1
*/
/*!
\fn void BLayoutItem::SetExplicitAlignment(BAlignment alignment) = 0
\brief Set this item's explicit alignment, to be used in Alignment().
\since Haiku R1
*/
@ -167,7 +197,7 @@
/*!
\name Getting and setting the visiblity of a BLayoutItem.
\name Getting/Setting the Visibility of a BLayoutItem
These methods take into account only the local visibility of this
item, not the visibility of its ancestors. \n
@ -185,12 +215,16 @@
A simple implementation would return the last thing passed to SetVisible().
A more complex implementation may deal with a BView that could
be hidden in any number of ways.
\since Haiku R1
*/
/*!
\fn void BLayoutItem::SetVisible(bool visible) = 0
\brief Set the local visibility of this item.
\since Haiku R1
*/
@ -198,7 +232,7 @@
/*!
\name Getting and setting the current on-screen positioning of a BLayoutItem.
\name Getting/Setting Current On-Screen Positioning of a BLayoutItem
*/
@ -208,7 +242,9 @@
/*!
\fn void BLayoutItem::AlignInFrame(BRect frame)
\brief Position this BLayoutItem within \a frame, given the value returned
by Alignment(), and the size constraints for this item.
by Alignment(), and the size constraints for this item.
\since Haiku R1
*/
@ -218,6 +254,8 @@
The returned BRect is in the coordinate system of the target view of the
BLayout this item belongs to.
\since Haiku R1
*/
@ -226,7 +264,9 @@
\brief Set the bounding frame of this item.
\a frame is in the coordinate system of the target view of the BLayout
that this item belongs to.
that this item belongs to.
\since Haiku R1
*/
@ -236,17 +276,19 @@
/*!
\fn BView* BLayoutItem::View()
\brief Return the BView this item is representing, or \c NULL if it does not
represent any view.
represent any view.
When a BLayoutItem is added to a BLayout, this method is called, and the
returned BView will be added to the BLayout&apos;s target view.
\since Haiku R1
*/
/*!
\name Layout events and requests.
\name Layout Events and Requests
\brief These methods represent events or requests originating from a
These methods represent events or requests originating from a
BLayout. In some implementations they may be handled directly by this
BLayoutItem, but many implementations will forward these events to
another object.
@ -259,7 +301,6 @@
/*!
\fn void BLayoutItem::InvalidateLayout(bool children = false)
\brief Invalidate the layout of this item, or the object it represents.
\param children Whether or not to invalidate children of this object.
Although this method is virtual, you should not override it in your classes,
override LayoutInvalidated() instead. This method will take care of calling
@ -267,6 +308,10 @@
there is an object that is somehow connected to this one by means other than
the standard mechanisms provided by the Haiku API, you should use
the LayoutInvalidated() hook to do this.
\param children Whether or not to invalidate children of this object.
\since Haiku R1
*/
@ -279,6 +324,8 @@
most cases. Assuming \c this->View() doesn't return \c NULL, the default
implementation calls Relayout() or Layout() on the value returned
by View().
\since Haiku R1
*/
@ -286,9 +333,10 @@
/*!
\name Utility methods for BLayout subclasses
\brief Utility methods for the BLayout class to attach and retrieve
arbitrary data for a BLayoutItem.
\name Utility Methods for BLayout Subclasses
Utility methods for the BLayout class to attach and retrieve
arbitrary data for a BLayoutItem.
*/
@ -300,6 +348,8 @@
\brief Retrieve arbitrary data attached to this BLayoutItem.
\note This method should only be called by a BLayout subclass.
\since Haiku R1
*/
@ -308,6 +358,8 @@
\brief Attach arbitrary data to this BLayoutItem.
\note This method should only be called by a BLayout subclass.
\since Haiku R1
*/
@ -332,35 +384,41 @@
If \a children is \c true, then you should invalidate any information on
child objects as well, and propagate the invalidation to them.
\since Haiku R1
*/
/*!
\fn void BLayoutItem::AttachedToLayout()
\brief Hook called when this object is attached to a BLayout (via
BLayout::AddItem())
BLayout::AddItem())
\note You can find the BLayout you've been attached to with the Layout()
method.
method.
\since Haiku R1
*/
/*!
\fn void BLayoutItem::DetachedFromLayout(BLayout* layout)
\brief Hook called when this object is attached to a BLayout (via
BLayout::RemoveItem())
BLayout::RemoveItem())
\warning You should not use this hook to reattach \c this to \a BLayout,
doing so will cause undefined behaviour (probably a crash).
doing so will cause undefined behaviour (probably a crash).
\param layout The BLayout you were previously attached to.
\since Haiku R1
*/
/*!
\fn void BLayoutItem::AncestorVisibilityChanged(bool shown)
\brief Hook called when this BLayoutItem&apos;s ancestors change visibility,
effectively hiding or showing this item.
effectively hiding or showing this item.
Implementations of this method should alter the onscreen visibility of this
item. I.E. if \a shown is \c false, nothing should be drawn to represent
@ -370,6 +428,8 @@
IsVisible() method.
\param shown \c true to show, \c false to hide.
\since Haiku R1
*/

53
docs/user/interface/ListItem.dox
View File

@ -24,6 +24,8 @@
\ingroup interface
\ingroup libbe
\brief A list item, a member of a BListView or BOutlineListView.
\since BeOS R3
*/
@ -38,6 +40,8 @@
\param expanded Whether or not the item is expanded.
\see BOutlineListView::AddItem()
\since BeOS R3
*/
@ -46,6 +50,8 @@
\brief Create a new list item from archived message.
\param data The message to create the list item from.
\since BeOS R3
*/
@ -54,15 +60,27 @@
\brief Destroy the list item freeing any memory used.
The default destructor is empty.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn status_t BListItem::Archive(BMessage* archive, bool deep) const
\brief Archive the list item to a message.
\param archive The message to archive the list item to.
\param deep If \c true also archive child views.
\since BeOS R3
*/
@ -74,14 +92,21 @@
\param frame The frame of the item.
\param complete Whether or not to draw the background in addition to the
item's contents.
\since BeOS R3
*/
//! @}
/*!
\fn float BListItem::Height() const
\brief Return the height of the list item.
\return The height of the list item as a float.
\since BeOS R3
*/
@ -90,6 +115,8 @@
\brief Return the width of the list item.
\return The width of the list item as a float.
\since BeOS R3
*/
@ -98,18 +125,24 @@
\brief Return whether or not the list item is currently selected.
\return \c true if the list item is selected, \c false otherwise.
\since BeOS R3
*/
/*!
\fn void BListItem::Select()
\brief Select the list item.
\since BeOS R3
*/
/*!
\fn void BListItem::Deselect()
\brief Unselect the list item.
\since BeOS R3
*/
@ -118,6 +151,8 @@
\brief Enable or disable the list item.
\param on Set \c true to enable, \c false to disable the list item.
\since BeOS R3
*/
@ -126,6 +161,8 @@
\brief Returns whether or not the list item is currently enabled.
\return \c true if the list item is enabled, \c false if it is disabled.
\since BeOS R3
*/
@ -134,6 +171,8 @@
\brief Set the height of the list item to \a height.
\param height The height to set the list item to.
\since BeOS R3
*/
@ -142,6 +181,8 @@
\brief Set the width of the list item to \a width.
\param width The width to set the list item to.
\since BeOS R3
*/
@ -156,6 +197,8 @@
\param owner The list item's new \a owner.
\param font The font set to the list item's current \a owner.
\since BeOS R3
*/
@ -167,6 +210,8 @@
\param arg A pointer to some data to perform on.
\return A status code.
\since Haiku R1
*/
@ -177,6 +222,8 @@
\param expanded \c true to expand the list item, \c false to un-expand the
list item.
\since BeOS R3
*/
@ -185,6 +232,8 @@
\brief Returns whether or not the list item is currently expanded.
\return \c true if the list item is expanded, \c false if it is not expanded.
\since BeOS R3
*/
@ -194,6 +243,8 @@
sense if the list item is part of a BOutlineListView.
\return The current outline level of the list item.
\since BeOS R3
*/
@ -202,4 +253,6 @@
\brief Set the outline level of the list item.
\param level The outline level to set the list item to.
\since BeOS R3
*/

223
docs/user/interface/ListView.dox
View File

@ -1,5 +1,5 @@
/*
* Copyright 2013 Haiku, Inc. All rights reserved.
* Copyright 2014 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
@ -65,6 +65,8 @@
\see BList in the Support Kit.
\see BOutlineListView
\see BListItem
\since BeOS R3
*/
@ -79,6 +81,8 @@
selections.
\param resizingMode The resizing mode flags. See BView for details.
\param flags The view flags. See BView for details.
\since BeOS R3
*/
@ -92,6 +96,8 @@
\param type Whether the list view supports a single selection or multiple
selections.
\param flags The view flags. See BView for details.
\since Haiku R1
*/
@ -101,6 +107,8 @@
\param type Whether the list view supports a single selection or multiple
selections.
\since Haiku R1
*/
@ -109,6 +117,8 @@
\brief Creates a BListView object from the \a archive message.
\param archive The message to create the object from.
\since BeOS R3
*/
@ -117,6 +127,8 @@
\brief Delete the BListView object and free the memory used by it.
This method does not free the attached list items.
\since BeOS R3
*/
@ -132,16 +144,15 @@
\fn BArchivable* BListView::Instantiate(BMessage* archive)
\brief Create a new BListView object from the message \a archive.
\param archive The message to create the object from.
\copydetails BView::Instantiate()
*/
/*!
\fn status_t BListView::Archive(BMessage* archive, bool deep) const
\fn status_t BListView::Archive(BMessage* data, bool deep) const
\brief Archive the BListView object to a message.
\param archive The message to archive the object to.
\param deep \c true to archive child views.
\copydetails BView::Archive()
*/
@ -149,7 +160,7 @@
/*!
\name Hook methods
\name Hook Methods
*/
@ -165,6 +176,8 @@
\param updateRect The rectangular area to draw.
\see BView::Draw()
\since BeOS R3
*/
@ -172,7 +185,7 @@
\fn void BListView::AttachedToWindow()
\brief Hook method called when the list view is added to the view hierarchy.
\see BView::AttachedToWindow()
\copydetails BView::AttachedToWindow()
*/
@ -181,7 +194,7 @@
\brief Hook method that is called when the list view is removed from the
view hierarchy.
\see BView::DetachedFromWindow()
\copydetails BView::DetachedFromWindow()
*/
@ -189,7 +202,7 @@
\fn void BListView::AllAttached()
\brief Hook method called once all views are attached to the view.
\see BView::AllAttached()
\copydetails BView::AllAttached()
*/
@ -197,46 +210,42 @@
\fn void BListView::AllDetached()
\brief Hook method called once all views are detached from the view.
\see BView::AllDetached()
\copydetails BView::AllDetached()
*/
/*!
\fn void BListView::FrameResized(float width, float height)
\fn void BListView::FrameResized(float newWidth, float newHeight)
\brief Hook method called when the list view is resized.
\param width The new \a width of the list view.
\param height The new \a height of the list view.
\see BView::FrameResized()
\copydetails BView::FrameResized()
*/
/*!
\fn void BListView::FrameMoved(BPoint new_position)
\fn void BListView::FrameMoved(BPoint newPosition)
\brief Hook method called when the list view is moved.
\param new_position The list view's new position.
\copydetails BView::FrameMoved()
*/
/*!
\fn void BListView::TargetedByScrollView(BScrollView *view)
\fn void BListView::TargetedByScrollView(BScrollView* view)
\brief Hook method called when the list view is attached to a BScrollView.
\param view The BScrollView the list view is attached to.
\since BeOS R3
*/
/*!
\fn void BListView::WindowActivated(bool state)
\fn void BListView::WindowActivated(bool active)
\brief Hook method that is called when the window becomes the active window
or gives up that status.
\param state If \c true, window has just been activated. If \c false the
window has just been deactivated.
\see BView::WindowActivated()
\copydetails BView::WindowActivated()
*/
@ -244,9 +253,7 @@
\fn void BListView::MessageReceived(BMessage* message)
\brief Hook method called when a message is received by the list view.
\param message The message received by the list view.
\see BView::MessageReceived()
\copydetails BView::MessageReceived()
*/
@ -270,6 +277,8 @@
\param numBytes The size of \a bytes.
\see BView::KeyDown()
\since BeOS R3
*/
@ -285,6 +294,8 @@
\param point The \a point where the mouse button was pushed down.
\see BView::MouseDown()
\since BeOS R3
*/
@ -296,6 +307,8 @@
\param where The location that the mouse button was released.
\see BView::MouseUp()
\since BeOS R3
*/
@ -310,6 +323,8 @@
\param dragMessage A message containing drag and drop information.
\see BView::MouseMoved()
\since BeOS R3
*/
@ -329,6 +344,8 @@
\returns \c true if a drag & drop operation was initiated, \c false
otherwise.
\since BeOS R3
*/
@ -338,6 +355,8 @@
This method should be implemented by derived classes, the default
implementation does nothing.
\since BeOS R3
*/
@ -345,7 +364,7 @@
/*!
\name Resize methods
\name Resizing
*/
@ -357,6 +376,8 @@
\brief Resize the view to it's preferred size.
\see BView::ResizeToPreferred()
\since BeOS R3
*/
@ -369,6 +390,8 @@
\param _height The list view's preferred height is written to \a _height.
\see BView::GetPreferredSize()
\since BeOS R3
*/
@ -379,6 +402,8 @@
\return The minimum size of the list view as a BSize.
\see BView::MinSize()
\since Haiku R1
*/
@ -389,6 +414,8 @@
\return The maximum size of the list view as a BSize.
\see BView::MaxSize()
\since Haiku R1
*/
@ -399,6 +426,8 @@
\return The preferred size of the list view as a BSize.
\see BView::PreferredSize()
\since Haiku R1
*/
@ -413,6 +442,8 @@
\param focused \c true to receive focus or \c false to lose it.
\see BView::MakeFocus()
\since BeOS R3
*/
@ -425,6 +456,8 @@
\param mask A \a mask indicating which properties of \a font to set.
\see BView::SetFont()
\since BeOS R3
*/
@ -435,11 +468,13 @@
\param point The location to scroll the list view to.
\see BView::ScrollTo()
\since BeOS R3
*/
/*!
\name Add and remove item methods
\name Adding/Removing Items
*/
@ -455,6 +490,8 @@
specified the item is added to the end.
\return \c true if the list item was added, \c false otherwise.
\since BeOS R3
*/
@ -468,6 +505,8 @@
\a list is added to the end.
\return \c true if the \a list was added, \c false otherwise.
\since BeOS R3
*/
@ -478,6 +517,8 @@
\param list The \a list of list items to add.
\return \c true if the \a list was added, \c false otherwise.
\since BeOS R3
*/
@ -488,6 +529,8 @@
\param index The \a index of the item to remove.
\return \c true if the item was removed, \c false otherwise.
\since BeOS R3
*/
@ -498,6 +541,8 @@
\param item The list item to remove.
\return \c true if the \a item was removed, \c false otherwise.
\since BeOS R3
*/
@ -509,6 +554,8 @@
\param count The number of items past \a index to remove.
return \c true if the \a items were removed, \c false otherwise.
\since BeOS R3
*/
@ -516,7 +563,7 @@
/*!
\name Selection and Invocation message methods
\name Selection and Invocation Message Methods
*/
@ -529,6 +576,8 @@
is selected.
\param message The selection \a message to set.
\since BeOS R3
*/
@ -539,6 +588,8 @@
\param message The invocation \a message to set.
\see BInvoker::SetMessage()
\since BeOS R3
*/
@ -549,6 +600,8 @@
\return The current invocation method as a BMessage.
\see BInvoker::Message()
\since BeOS R3
*/
@ -559,6 +612,8 @@
\returns The what parameter of the currently set invocation method.
\see BInvoker::Command()
\since BeOS R3
*/
@ -567,6 +622,8 @@
\brief Returns the message that is send when an item is selected.
\return The current selection message as a BMessage.
\since BeOS R3
*/
@ -576,6 +633,8 @@
selected.
\return The what parameter of the current selection message.
\since BeOS R3
*/
@ -583,7 +642,7 @@
/*!
\name List type methods
\name List Type Methods
*/
@ -594,6 +653,8 @@
\fn void BListView::SetListType(list_view_type type)
\brief Sets the list view \a type.
\since BeOS R3
\param type The list view \a type to set.
*/
@ -603,6 +664,8 @@
\brief Returns the current list view type.
\return The list view type.
\since BeOS R3
*/
@ -610,7 +673,7 @@
/*!
\name List methods
\name List Methods
*/
@ -624,6 +687,8 @@
\param index
\return The list item at the specified \a index.
\since BeOS R3
*/
@ -634,6 +699,8 @@
\param item The list item to get the index of.
\return The index of the specified \a item.
\since BeOS R3
*/
@ -644,6 +711,8 @@
\param point The location of the list item to get the index of.
\return The index of the list item at the specified \a point.
\since BeOS R3
*/
@ -652,6 +721,8 @@
\brief Returns a pointer to the first list item.
\return A pointer to the first item in the list or \c NULL there are no items.
\since BeOS R3
*/
@ -660,6 +731,8 @@
\brief Returns a pointer to the last list item.
\return A pointer to the last item in the list or \c NULL there are no items.
\since BeOS R3
*/
@ -670,6 +743,8 @@
\param item The list item to check.
\return \c true if \a item is in the list, \c false otherwise.
\since BeOS R3
*/
@ -678,12 +753,16 @@
\brief Returns the number of items contained in the list view.
\return The number of items.
\since BeOS R3
*/
/*!
\fn void BListView::MakeEmpty()
\brief Empties the list view of all items.
\since BeOS R3
*/
@ -692,6 +771,8 @@
\brief Returns whether or not the list view is empty.
\return \c true if the list view is empty, \c false otherwise.
\since BeOS R3
*/
@ -707,6 +788,8 @@
The first argument of \a func is a pointer to the list item.
\param func The function to call on each item.
\since BeOS R3
*/
@ -725,6 +808,8 @@
\param func The function to call on each item.
\param arg The second argument of the function.
\since BeOS R3
*/
@ -733,6 +818,8 @@
\brief Returns a pointer to the list of list items.
\returns a pointer to the list of list items.
\since BeOS R3
*/
@ -744,11 +831,13 @@
\brief Draws the list item at the specified \a index.
\param index The \a index of the list item to draw.
\since Haiku R1
*/
/*!
\name Selection methods
\name Selection
*/
@ -758,6 +847,8 @@
/*!
\fn void BListView::ScrollToSelection()
\brief Scrolls to selected list item.
\since BeOS R3
*/
@ -767,6 +858,8 @@
\param index The \a index of the item to select.
\param extend Whether or not to also select child items.
\since BeOS R3
*/
@ -777,6 +870,8 @@
\param start The index of the item to start the selection.
\param finish The index of the item to end the selection.
\param extend Whether or not to also select child items.
\since BeOS R3
*/
@ -785,6 +880,8 @@
\brief Returns whether or not the item at \a index is selected.
\return \c true if the item was selected, \c false otherwise.
\since BeOS R3
*/
@ -800,6 +897,8 @@
\param index The \a index of the item to get relative to the selected item's
index.
\since BeOS R3
*/
@ -815,11 +914,13 @@
message.
\see BControl::Invoke()
\since BeOS R3
*/
/*!
\name Deselection methods
\name Deselection
*/
@ -829,6 +930,8 @@
/*!
\fn void BListView::DeselectAll()
\brief Deselect all items.
\since BeOS R3
*/
@ -839,6 +942,8 @@
\param exceptFrom The index of the start of the exception list.
\param exceptTo The index of the end of the exception list.
\since BeOS R3
*/
@ -847,6 +952,8 @@
\brief Deselect the item at \a index.
\param index The \a index of the item to deselect.
\since BeOS R3
*/
@ -858,6 +965,8 @@
\brief Sort the items according the the passed in \a cmp function.
\param cmp The compare function to use to sort the items.
\since BeOS R3
*/
@ -869,6 +978,8 @@
\param b The index of the second item to swap.
\return \c true if the items were swapped, \c false otherwise.
\since BeOS R3
*/
@ -880,6 +991,8 @@
\param to The index to move the item to.
\return \c true if the item was moved, \c false otherwise.
\since BeOS R3
*/
@ -891,6 +1004,8 @@
\param item The \a item to replace the item at \a index with.
\return \c true if the item was replaced, \c false otherwise.
\since BeOS R3
*/
@ -901,23 +1016,17 @@
\param index The \a index of the item to get the frame of.
\returns The frame of the item at \a index.
\since BeOS R3
*/
/*!
\fn BHandler* BListView::ResolveSpecifier(BMessage* message, int32 index,
BMessage* specifier, int32 form, const char* property);
\brief Returns the proper handler for the passed in scripting \a message.
BMessage* specifier, int32 what, const char* property);
\brief Determines the proper handler for the passed in scripting \a message.
\param message The scripting message to determine the handler.
\param index The index of the specifier.
\param specifier The message which contains the specifier.
\param form The 'what' field of the specifier message.
\param property The name of the target property.
\return The proper BHandler for the passed in scripting \a message.
\see BView::ResolveSpecifier()
\copydetails BView::ResolveSpecifier()
*/
@ -926,9 +1035,7 @@
\brief Reports the suites of messages and specifiers that derived classes
understand.
\param data The message to report the suite of messages and specifiers.
\see BView::GetSupportedSuites()
\copydetails BView::GetSupportedSuites()
*/
@ -936,10 +1043,20 @@
\fn status_t BListView::Perform(perform_code code, void* _data)
\brief Performs an action give a perform_code and data. (Internal Method)
\param code The perform code
\param _data A pointer to some data to perform on
\return A status code.
\see BView::Perform()
\copydetails BHandler::Perform()
*/
/*!
\fn bool BListView::DoMiscellaneous(MiscCode code, MiscData* data)
\brief Do a miscellaneous action.
\param code The action \a code to use.
- \c B_NO_OP: Do nothing
- \c B_REPLACE_OP: Replace the item in \a data
- \c B_MOVE_OP: Move the item in \a data.
- \c B_SWAP_OP: Swap the items in \a data.
\param data The \a data to act on.
\since Haiku R1
*/

172
docs/user/interface/Menu.dox
View File

@ -24,6 +24,8 @@
\ingroup interface
Constants to define the layout of the menu items in a menu.
\since BeOS R3
*/
@ -31,6 +33,8 @@
\var menu_layout B_ITEMS_IN_ROW
Items are arranged in a row, one next to the other.
\since BeOS R3
*/
@ -38,6 +42,8 @@
\var menu_layout B_ITEMS_IN_COLUMN
Items are arranged in a column, one on top of the other.
\since BeOS R3
*/
@ -45,6 +51,8 @@
\var menu_layout B_ITEMS_IN_MATRIX
Items are arranged in a matrix, a free-form arrangement that you create.
\since BeOS R3
*/
@ -54,6 +62,8 @@
\ingroup libbe
\brief Information about a menu such as font size and family, background
color, and flags.
\since BeOS R3
*/
@ -61,6 +71,8 @@
\var menu_info::font_size
The font size to draw menu items with.
\since BeOS R3
*/
@ -68,6 +80,8 @@
\var menu_info::f_family
The font family used to draw menu items.
\since BeOS R3
*/
@ -75,6 +89,8 @@
\var menu_info::f_style
The font style used to draw menu items.
\since BeOS R3
*/
@ -82,6 +98,8 @@
\var menu_info::background_color
The menu's background color.
\since BeOS R3
*/
@ -89,6 +107,8 @@
\var menu_info::separator
The style of horizontal line to use to separates groups of items in a menu.
\since BeOS R3
*/
@ -96,6 +116,8 @@
\var menu_info::click_to_open
Whether or not the menu opens on click. The default value is \c true.
\since BeOS R3
*/
@ -104,12 +126,16 @@
Whether or not trigger underlines should always be shown. The default value
is \c false.
\since BeOS R3
*/
/*!
\fn status_t get_menu_info(menu_info* info)
\brief Fill out the menu_info struct into \a info.
\since BeOS R3
*/
@ -117,12 +143,16 @@
\fn status_t set_menu_info(menu_info* info)
\brief Set the menu's menu_info struct to \a info adjusting how the menu
will look and work.
\since BeOS R3
*/
/*!
\typedef bool (*menu_tracking_hook)(BMenu* menu, void* state)
\brief Defines the function passed into BMenu::SetTrackingHook().
\since BeOS R3
*/
@ -180,6 +210,8 @@
Several methods will only work in some layouts as noted in the method
description below.
\since BeOS R3
*/
@ -194,6 +226,8 @@
\param layout The menu layout, possibilities include:
- \c B_ITEMS_IN_ROW items are displayed in a single row,
- \c B_ITEMS_IN_COLUMN items are displayed in a single column.
\since BeOS R3
*/
@ -205,6 +239,8 @@
\param name The menu's \a name, serves as a label for submenus.
\param width The menu \a width.
\param height The menu \a height.
\since BeOS R3
*/
@ -213,6 +249,8 @@
\brief Archive constructor.
\param archive The message data to construct the menu from.
\since BeOS R3
*/
@ -221,15 +259,27 @@
\brief Destructor.
Also frees the memory used by any attached menu items and submenus.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BMenu::Instantiate(BMessage* archive)
\brief Creates a new BMenu object from an \a archive message.
\returns A newly created BMenu object or \c NULL if the message doesn't
contain an archived BMenu.
\since BeOS R3
*/
@ -244,12 +294,27 @@
otherwise.
\retval B_OK The object was archived successfully.
\retval B_NO_MEMORY Ran out of memory while archiving the object.
\since BeOS R3
*/
//! @}
/*!
\name Hook Methods
*/
//! @{
/*!
\fn void BMenu::AttachedToWindow()
\brief Lays out the menu items and resizes the menu to fit.
\since BeOS R3
*/
@ -258,6 +323,8 @@
\brief Draws the menu.
\param updateRect The area to draw in.
\since BeOS R3
*/
@ -270,6 +337,8 @@
to scroll faster.
\param message The \a message received by the associated looper.
\since BeOS R3
*/
@ -281,9 +350,14 @@
\param bytes The bytes of the key combination pressed.
\param numBytes The number of bytes in \a bytes.
\since BeOS R3
*/
//! @}
/*!
\fn bool BMenu::AddItem(BMenuItem* item)
\brief Adds a menu \a item to the end of the list.
@ -295,6 +369,8 @@
\param item The menu \a item to add.
\return Whether or not the \a item was added to the menu.
\since BeOS R3
*/
@ -310,6 +386,8 @@
\param index The \a index where to add the \a item to the menu.
\return Whether or not the \a item was added to the menu.
\since BeOS R3
*/
@ -325,6 +403,8 @@
\param frame The \a frame rectangle where to add the \a item to the menu.
\return Whether or not the \a item was added to the menu.
\since BeOS R3
*/
@ -339,6 +419,8 @@
\param submenu The submenu to add.
\return Whether or not the \a submenu was added to the menu.
\since BeOS R3
*/
@ -354,6 +436,8 @@
\param index The \a index where to add the \a submenu to the menu.
\return Whether or not the \a submenu was added to the menu.
\since BeOS R3
*/
@ -370,6 +454,8 @@
\param frame The \a frame rectangle where to add the submenu to the menu.
\return Whether or not the \a submenu was added to the menu.
\since BeOS R3
*/
@ -385,6 +471,8 @@
\param index The \a index where to add the \a list to the menu.
\return Whether or not the \a list of menu items was added to the menu.
\since BeOS R3
*/
@ -397,6 +485,8 @@
\c B_ITEMS_IN_ROW or \c B_ITEMS_IN_MATRIX layout.
\return Whether or not the separator item was added to the menu.
\since BeOS R3
*/
@ -405,6 +495,8 @@
\brief Remove and delete the specified \a item from the menu.
\return Whether or not the \a item was removed from the menu.
\since BeOS R3
*/
@ -421,6 +513,8 @@
\param index The \a index of where to remove the menu item.
\return The menu item object or \c NULL if not found.
\since BeOS R3
*/
@ -438,6 +532,8 @@
\param deleteItems Whether or not to delete the items after removing them.
\return Whether or not the items were removed from the menu.
\since BeOS R3
*/
@ -448,6 +544,8 @@
\param submenu The submenu to remove.
\return Whether or not the \a submenu was removed from the menu.
\since BeOS R3
*/
@ -456,6 +554,8 @@
\brief Returns the number of items added to the menu.
\return The number of items added to the menu.
\since BeOS R3
*/
@ -468,6 +568,8 @@
a menu in \c B_ITEMS_IN_MATRIX layout.
\return A pointer to a menu item or \c NULL if not found.
\since BeOS R3
*/
@ -480,6 +582,8 @@
menu in \c B_ITEMS_IN_MATRIX layout.
\return A pointer to a submenu or \c NULL if not found.
\since BeOS R3
*/
@ -495,6 +599,8 @@
a menu in \c B_ITEMS_IN_MATRIX layout.
\return The index of the menu \a item or \c B_ERROR of not found.
\since BeOS R3
*/
@ -510,6 +616,8 @@
a menu in \c B_ITEMS_IN_MATRIX layout.
\return The index of the \a submenu or \c B_ERROR of not found.
\since BeOS R3
*/
@ -520,6 +628,8 @@
\param label The \a label of the menu item to find.
\return A pointer to a menu item or \c NULL if not found.
\since BeOS R3
*/
@ -532,6 +642,8 @@
find.
\return A pointer to a menu item or \c NULL if not found.
\since BeOS R3
*/
@ -547,6 +659,8 @@
that have already been added to the menu.
\return \c B_OK on success or an error code on error.
\since BeOS R3
*/
@ -563,6 +677,8 @@
to.
\return \c B_OK on success or an error code on error.
\since BeOS R3
*/
@ -571,6 +687,8 @@
\brief Enables or disables the menu.
\param enable \c true to enable, \c false to disable.
\since BeOS R3
*/
@ -592,6 +710,8 @@
the items yourself.
\param on \c true to turn radio mode on, \c false to turn it off.
\since BeOS R3
*/
@ -600,6 +720,8 @@
\brief Enables or disables triggers.
\param enable \c true to enable triggers, \c false to disable triggers.
\since BeOS R3
*/
@ -612,6 +734,8 @@
included as part of the maximum content width.
\param width The maximum width for the menu item contents to draw in.
\since BeOS R3
*/
@ -624,6 +748,8 @@
\param on \c true to turn label-from-marked mode on, \c false to turn it
off.
\since BeOS R3
*/
@ -632,6 +758,8 @@
\brief Returns whether or not the menu is in label-from-marked mode.
\return \c true if menu is in label-from-marked mode, \c false if not.
\since BeOS R3
*/
@ -640,6 +768,8 @@
\brief Returns whether or not the menu is enabled.
\return \c true if menu is enabled, \c false if it is disabled.
\since BeOS R3
*/
@ -648,6 +778,8 @@
\brief Returns whether or not the menu is in radio mode.
\return \c true if menu is in radio mode, \c false if not.
\since BeOS R3
*/
@ -656,6 +788,8 @@
\brief Returns whether or not triggers are enabled.
\return \c true if triggers are enabled, \c false if triggers are disabled.
\since BeOS R3
*/
@ -664,6 +798,8 @@
\brief Returns whether or not the menu is in redraw-after-sticky mode.
\return \c true if menu is in redraw-after-sticky mode, \c false if not.
\since Haiku R1
*/
@ -672,6 +808,10 @@
\brief Return the maximum width of the menu items' content area.
\return The maximum width of the menu items' content area as a float.
\sa SetMaxContentWidth()
\since BeOS R3
*/
@ -687,6 +827,8 @@
a menu in \c B_ITEMS_IN_MATRIX layout.
\return A pointer to the first marked menu item or \c NULL if not found.
\since BeOS R3
*/
@ -702,6 +844,8 @@
a menu in \c B_ITEMS_IN_MATRIX layout.
\return The index of the first marked menu item or -1 if not found.
\since Haiku R1
*/
@ -710,6 +854,8 @@
\brief Returns the pointer to the menu that this menu it attached to.
\return A pointer to a BMenu object or \c NULL if not found.
\since BeOS R3
*/
@ -718,6 +864,8 @@
\brief Returns the pointer to the menu item that this menu it attached to.
\return A pointer to a BMenuItem object or \c NULL if not found.
\since BeOS R3
*/
@ -744,6 +892,8 @@
\param resizeToFit Whether or not the menu should automatically resize
itself to fit its contents, this will not work in
\c B_ITEMS_IN_MATRIX layout.
\since BeOS R3
*/
@ -756,6 +906,8 @@
\param top The top margin to set.
\param right The right margin to set.
\param bottom The bottom margin to set.
\since BeOS R3
*/
@ -768,12 +920,16 @@
\param _top The top margin to fill out, can be \c NULL.
\param _right The right margin to fill out, can be \c NULL.
\param _bottom The bottom margin to fill out, can be \c NULL.
\since BeOS R3
*/
/*!
\fn menu_layout BMenu::Layout() const
\brief Returns the current menu_layout constant.
\since BeOS R3
*/
@ -795,6 +951,8 @@
\return A BMenuItem object if the user ends tracking by invoking an item or
\c NULL if the user didn't invoke an item.
\since BeOS R3
*/
@ -808,6 +966,8 @@
- \c B_ABORT
\return \c true if the dynamic item was added, \c false otherwise.
\since Haiku R1
*/
@ -816,6 +976,8 @@
\brief Draw the menu background within the bounds of \a updateRect.
\param updateRect The area to draw the background in.
\since Haiku R1
*/
@ -825,12 +987,6 @@
\param func The hook function to call.
\param state A variable passed to the hook function.
*/
/*!
\fn void BMenu::_DrawItems(BRect updateRect)
\brief Draw the menu items within \a updateRect.
\param updateRect The area to draw the menu items in.
\since Haiku R1
*/

61
docs/user/interface/MenuBar.dox
View File

@ -26,6 +26,8 @@
Menu bar border style constants.
\see BMenuBar::SetBorder()
\since BeOS R3
*/
@ -33,6 +35,8 @@
\var menu_bar_border B_BORDER_FRAME
The border is drawn around the entire menu bar.
\since BeOS R3
*/
@ -40,14 +44,17 @@
\var menu_bar_border B_BORDER_CONTENTS
The border is drawn around the list of items.
*/
\since BeOS R3
*/
/*!
\var menu_bar_border B_BORDER_EACH_ITEM
The border is drawn around each individual item.
\since BeOS R3
*/
@ -76,6 +83,8 @@
you'll need to call AddItem() or AddList() to add some. The top-level items
in a menu bar are typically menus which have menu items and menus added to
them in turn.
\since BeOS R3
*/
@ -120,6 +129,8 @@
\param resizeToFit Whether or not the menu bar should automatically resize
itself to fit its contents, this will not work in
\c B_ITEMS_IN_MATRIX layout.
\since BeOS R3
*/
@ -133,6 +144,8 @@
- \c B_ITEMS_IN_ROW items are displayed in a single row,
- \c B_ITEMS_IN_COLUMN items are displayed in a single column,
- \c B_ITEMS_IN_MATRIX items are displayed in a custom matrix.
\since Haiku R1
*/
@ -141,6 +154,8 @@
\brief Archive constructor.
\param archive The message data to construct the menu from.
\since BeOS R3
*/
@ -149,15 +164,27 @@
\brief Destructor.
Also frees the memory used by any attached menus and menu items.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BMenuBar::Instantiate(BMessage* data)
\brief Creates a new BMenuBar object from an \a archive message.
\returns A newly created BMenuBar object or \c NULL if the message
doesn't contain an archived BMenuBar.
\since BeOS R3
*/
@ -172,15 +199,30 @@
otherwise.
\retval B_OK The object was archived successfully.
\retval B_NO_MEMORY Ran out of memory while archiving the object.
\since BeOS R3
*/
//! @}
/*!
\name Hook Methods
*/
//! @{
/*!
\fn void BMenuBar::AttachedToWindow()
\brief Sets this as the key menubar for the window, lays out the menu items
and resizes the menu to fit.
\see BWindow::SetKeyMenuBar()
\since BeOS R3
*/
@ -190,8 +232,7 @@
Redraws the affected borders.
\param newWidth The new \a width of the menu bar.
\param newHeight The new \a height of the menu bar.
\copydetails BView::FrameResized()
*/
@ -200,6 +241,8 @@
\brief Draws the menu bar.
\param updateRect The area to draw in.
\since BeOS R3
*/
@ -209,14 +252,16 @@
Right clicking on a menu bar sends the window to back or brings it to front.
\param where The point on the screen where to mouse pointer is when
the mouse button is pressed.
\copydetails BView::MouseDown()
*/
//! @}
/*!
\fn void BMenuBar::SetBorder(menu_bar_border border)
\brief Sets how the menu bar border is drawn.
\brief Specifies how the menu bar border is drawn.
The default is \c B_BORDER_FRAME.
@ -225,6 +270,8 @@
- \c B_BORDER_CONTENTS The border is drawn around the list of items.
- \c B_BORDER_EACH_ITEM The border is drawn around each individual
item.
\since BeOS R3
*/
@ -233,4 +280,6 @@
\brief Returns the currently set border style.
\see BMenuBar::SetBorder() for details.
\since BeOS R3
*/

108
docs/user/interface/MenuField.dox
View File

@ -61,6 +61,8 @@
typically used instead of a regular BMenu because it opens directly
underneath the mouse pointer and is set to radio mode and
label-from-marked mode by default, but, this is entirely up to you.
\since BeOS R3
*/
@ -76,6 +78,8 @@
\param resizingMode Defines the menu field's behavior when its parent is
resized, see BView for details.
\param flags The view flags, see BView for details.
\since BeOS R3
*/
@ -93,6 +97,8 @@
\param resizingMode Defines the menu field's behavior when its parent is
resized, see BView for details.
\param flags The view flags, see BView for details.
\since BeOS R3
*/
@ -101,12 +107,12 @@
uint32 flags)
\brief Creates a new BMenuField object suitable as part of a BLayout.
\note This method was not available in BeOS R5.
\param name The \a name of the menu field, internal only, can be \c NULL.
\param label The \a label shown to the user, can be blank.
\param menu The \a menu of choices shown to the user, typically a BPopUpMenu.
\param flags The view flags, see BView for details.
\since Haiku R1
*/
@ -115,11 +121,11 @@
\brief Creates a new BMenuField object suitable as part of a BLayout.
This constructor omits the internal name parameter.
\note This method was not available in BeOS R5.
\param label The \a label shown to the user, can be blank.
\param menu The \a menu of choices shown to the user, typically a BPopUpMenu.
\param flags The view flags, see BView for details.
\since Haiku R1
*/
@ -128,6 +134,8 @@
\brief Archive constructor.
\param data The message \a data to construct the menu field from.
\since BeOS R3
*/
@ -136,15 +144,27 @@
\brief Destructor.
Also frees the memory used by the label and menu.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BMenuField::Instantiate(BMessage* data)
\brief Creates a new BMenuField object from an \a data message.
\returns A newly created BMenuField object or \c NULL if the message
doesn't contain an archived BMenuField.
\since BeOS R3
*/
@ -161,9 +181,22 @@
otherwise.
\retval B_OK The object was archived successfully.
\retval B_NO_MEMORY Ran out of memory while archiving the object.
\since BeOS R3
*/
//! @}
/*!
\name Hook Methods
*/
//! @{
/*!
\fn status_t BMenuField::AllArchived(BMessage* into) const
\brief Hook method called when all views have been archived.
@ -171,6 +204,8 @@
Also archives the label and menu bar.
\param into Archived data message.
\since BeOS R3
*/
@ -181,6 +216,8 @@
Also unarchives the label and menu bar.
\param from Unarchived data message.
\since BeOS R3
*/
@ -191,6 +228,8 @@
Adjusts the background color to match the background color of the parent
view and adjusts the height to be the attached menu bar which depends on
the user's current menu font setting.
\since BeOS R3
*/
@ -201,6 +240,8 @@
If the attached menu bar is too narrow it is resized it to fit the menu
items.
\since BeOS R3
*/
@ -212,6 +253,8 @@
current focus view and whether or not it is enabled.
\param updateRect The rectangular area to be drawn.
\since BeOS R3
*/
@ -221,8 +264,7 @@
Adjusts the menu bar size and location.
\param newWidth The new \a width of the menu field.
\param newHeight The new \a height of the menu field.
\copydetails BView::FrameResized()
*/
@ -233,8 +275,7 @@
Provides for keyboard navigation allowing users to open the menu by pressing
the space bar, right arrow, or down arrow.
\param bytes The bytes of the key combination pressed.
\param numBytes The number of bytes in \a bytes.
\copydetails BView::KeyDown()
*/
@ -245,24 +286,25 @@
Provides the ability to open the menu field menu using the mouse, even if
the user clicks on the menu field label.
\param where The point on the screen where to mouse pointer is when
the mouse button is pressed.
\copydetails BView::MouseDown()
*/
/*!
\fn void BMenuField::WindowActivated(bool state)
\fn void BMenuField::WindowActivated(bool active)
\brief Hook method called when the attached window is activated or
deactivated.
Redraws the focus ring around the menu field when the window is activated
and deactivated if it is the window's current focus view.
\param state \c true if the window becomes activated, \c false if the
window becomes deactivated.
\copydetails BView::WindowActivated()
*/
//! @}
/*!
\fn void BMenuField::MakeFocus(bool focused)
\brief Makes the view the current focus view of the window or gives up
@ -271,6 +313,8 @@
Enables or disables keyboard navigation and invalidates the menu field.
\param focused \a true to set focus, \a false to remove it.
\since BeOS R3
*/
@ -278,6 +322,8 @@
\fn BMenu* BMenuField::Menu() const
\brief Returns a pointer to the menu attached to the menu bar that opens
when the user clicks on the menu field.
\since BeOS R3
*/
@ -285,6 +331,8 @@
\fn BMenuBar* BMenuField::MenuBar() const
\brief Returns a pointer to the attached menu bar that contains the pop-up
menu.
\since BeOS R3
*/
@ -292,6 +340,8 @@
\fn BMenuItem* BMenuField::MenuItem() const
\brief Returns the first menu item attached to the menu bar containing
the pop-up menu.
\since BeOS R3
*/
@ -300,6 +350,8 @@
\brief Sets the menu field label to \a label.
\param label The \a label to set to the menu field.
\since BeOS R3
*/
@ -308,6 +360,8 @@
\brief Returns the menu field label.
\return The menu field label or \c NULL if not assigned.
\since BeOS R3
*/
@ -316,6 +370,8 @@
\brief Enables or disables the menu field.
\param on \c true to enable the menu field, \c false to disable it.
\since BeOS R3
*/
@ -324,6 +380,8 @@
\brief Returns whether or not the menu is enabled.
\return \c true if the menu is enabled, \c false if disabled.
\since BeOS R3
*/
@ -339,6 +397,8 @@
- \c B_ALIGN_LEFT
- \c B_ALIGN_CENTER
- \c B_ALIGN_RIGHT
\since BeOS R3
*/
@ -349,6 +409,8 @@
\return The label's current alignment constant.
\see SetAlignment() for more details.
\since BeOS R3
*/
@ -365,6 +427,8 @@
menu fields.
\param position The divider \a position to set, should be an integral value.
\since BeOS R3
*/
@ -375,6 +439,8 @@
\return The current divider position as a float.
\see SetDivider() for more details.
\since BeOS R3
*/
@ -382,9 +448,9 @@
\fn void BMenuField::ShowPopUpMarker()
\brief Shows the pop-up marker located on the right edge of the menu bar.
\note This method was not available in BeOS R5.
\sa HidePopUpMarker()
\since Haiku R1
*/
@ -392,9 +458,9 @@
\fn void BMenuField::HidePopUpMarker()
\brief Hides to pop-up marker.
\note This method was not available in BeOS R5.
\sa ShowPopUpMarker()
\since Haiku R1
*/
@ -403,9 +469,9 @@
\brief Returns a pointer to the label layout item.
(Layout constructor only)
\note This method was not available in BeOS R5.
\sa CreateMenuBarLayoutItem()
\since Haiku R1
*/
@ -414,7 +480,7 @@
\brief Returns a pointer to the menu bar layout item.
(Layout constructor only)
\note This method was not available in BeOS R5.
\sa CreateLabelLayoutItem()
\since Haiku R1
*/

79
docs/user/interface/MenuItem.dox
View File

@ -65,6 +65,8 @@
submenu may still be opened but each of the items will be disabled.
\sa SetEnabled()
\since BeOS R3
*/
@ -79,6 +81,8 @@
\param shortcut The \a shortcut characters to activate the menu item.
\param modifiers The modifier keys to active the menu item,
\c B_COMMAND_KEY is assumed.
\since BeOS R3
*/
@ -92,6 +96,8 @@
\param menu The \a menu to assign to the item.
\param message The BMessage that is sent when the item is selected.
\since BeOS R3
*/
@ -100,15 +106,37 @@
\brief Archive constructor.
\param data The message \a data to construct the menu item from.
\since BeOS R3
*/
/*!
\fn BMenuItem::~BMenuItem()
\brief Destructor.
Also frees the memory used by the label or submenu.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BMenuItem::Instantiate(BMessage* data)
\brief Creates a new BMenuItem object from an \a data message.
\return A newly created BMenuItem object or \c NULL if the message
doesn't contain an archived BMenuItem.
\since BeOS R3
*/
@ -125,15 +153,12 @@
otherwise.
\retval B_OK The object was archived successfully.
\retval B_NO_MEMORY Ran out of memory while archiving the object.
\since BeOS R3
*/
/*!
\fn BMenuItem::~BMenuItem()
\brief Destructor.
Also frees the memory used by the label or submenu.
*/
//! @}
/*!
@ -144,6 +169,8 @@
Setting the label invalidates the attached menu.
\param string The \a string to set the label to.
\since BeOS R3
*/
@ -154,6 +181,8 @@
Enabling or disabling the menu item invalidates the attached menu.
\param enable \c true to enable the menu item, \c false to disable it.
\since BeOS R3
*/
@ -169,6 +198,8 @@
\param mark \c true to mark the menu item, \c false to unmark it.
\sa BMenu::SetRadioMode()
\since BeOS R3
*/
@ -180,6 +211,8 @@
\attention Triggers are currently disabled.
\param trigger The trigger character to set on this menu item.
\since BeOS R3
*/
@ -194,6 +227,8 @@
\param shortcut The ASCII shortcut character to set.
\param modifiers A bitmap mask of modifier keys used to activate
the shortcut.
\since BeOS R3
*/
@ -202,6 +237,8 @@
\brief Returns the item's label.
\return The item's label as a const char array.
\since BeOS R3
*/
@ -210,6 +247,8 @@
\brief Returns whether or not the item is enabled.
\return \c true if the item is enabled, \c false if disabled.
\since BeOS R3
*/
@ -218,6 +257,8 @@
\brief Returns whether or not the item is marked.
\return \c true if the item is marked, \c false if unmarked.
\since BeOS R3
*/
@ -226,6 +267,8 @@
\brief Returns the item's trigger character.
\return The current trigger character as a char or 0 if unset.
\since BeOS R3
*/
@ -237,6 +280,8 @@
\param modifiers A pointer to a uint32 to fill out.
\return The shortcut character assigned to the menu item as a char.
\since BeOS R3
*/
@ -245,6 +290,8 @@
\brief Returns a pointer to the attached menu.
\return A pointer to the attached menu.
\since BeOS R3
*/
@ -253,6 +300,8 @@
\brief Returns a pointer to the menu that the item is attached to.
\return A pointer to the menu that the item is attached to.
\since BeOS R3
*/
@ -262,6 +311,8 @@
\return The bounds rectangle of the menu item in the coordinate system
of the menu that the item is attached to.
\since BeOS R3
*/
@ -285,6 +336,8 @@
\sa ContentLocation()
\sa DrawContent()
\since BeOS R3
*/
@ -298,6 +351,8 @@
\param maxWidth The maximum number of bytes to truncate the label to.
\param newLabel The buffer to store the truncated label in.
\since BeOS R3
*/
@ -308,6 +363,8 @@
This method is called automatically by BMenu::Draw(), you need not call it
yourself. You may want to override this method in derived classes to do
something different than drawing a text label.
\since BeOS R3
*/
@ -321,6 +378,8 @@
and possibly a right arrow to indicate there is submenu and then calls
DrawContent() to fill in the label. Lastly Highlight() is called if the item
is selected.
\since BeOS R3
*/
@ -335,6 +394,8 @@
\param highlight Highlights if \a highlight is \c true,
unhighlights if \c false.
\since BeOS R3
*/
@ -343,6 +404,8 @@
\brief Returns whether or not the item is selected.
\return \c true if selected, \c false if not selected.
\since BeOS R3
*/
@ -362,6 +425,8 @@
\sa GetContentSize()
\sa DrawContent()
\since BeOS R3
*/
@ -385,4 +450,6 @@
\retval B_BAD_VALUE The message was \c NULL.
\sa BInvoker::Invoke()
\since BeOS R3
*/

129
docs/user/interface/OutlineListView.dox
View File

@ -35,6 +35,8 @@
\see BListView for more info on how to use a list view, most of which also
applies to an outline list view.
\since BeOS R3
*/
@ -49,6 +51,8 @@
selections.
\param resizingMode The resizing mode flags. See BView for details.
\param flags The view flags. See BView for details.
\since BeOS R3
*/
@ -61,6 +65,8 @@
\param type Whether the list view supports a single selection or multiple
selections.
\param flags The view flags. See BView for details.
\since Haiku R1
*/
@ -69,6 +75,8 @@
\brief Creates a BOutlineListView object from the \a archive message.
\param archive The message to create the object from.
\since BeOS R3
*/
@ -78,6 +86,8 @@
by it.
This method does not free the attached list items.
\since BeOS R3
*/
@ -94,6 +104,8 @@
\brief Create a new BOutlineListView object from the message \a archive.
\param archive The message to create the object from.
\since BeOS R3
*/
@ -103,6 +115,8 @@
\param archive The message to archive the object to.
\param deep \c true to archive child views.
\since BeOS R3
*/
@ -110,7 +124,7 @@
/*!
\name Hook methods
\name Hook Methods
*/
@ -119,19 +133,13 @@
/*!
\fn void BOutlineListView::AllAttached()
\brief Hook method called once all views are attached to the outline list
view.
\see BView::AllAttached()
\copydoc BView::AllAttached()
*/
/*!
\fn void BOutlineListView::AllDetached()
\brief Hook method called once all views are detached from the outline list
view.
\see BView::AllDetached()
\copydoc BView::AllDetached()
*/
@ -140,28 +148,23 @@
\brief Hook method that is called when the outline list view is removed from
the view hierarchy.
\see BView::DetachedFromWindow()
\copydetails BView::DetachedFromWindow()
*/
/*!
\fn void BOutlineListView::FrameMoved(BPoint new_position)
\fn void BOutlineListView::FrameMoved(BPoint newPosition)
\brief Hook method called when the outline list view is moved.
\param new_position The list view's new position.
\see BView::FrameMoved()
\copydetails BView::FrameMoved()
*/
/*!
\fn void BOutlineListView::FrameResized(float width, float height)
\fn void BOutlineListView::FrameResized(float newWidth, float newHeight)
\brief Hook method called when the outline list view is resized.
\param width The new \a width of the view.
\param height The new \a height of the view.
\see BView::FrameResized()
\copydetails BView::FrameResized()
*/
@ -182,6 +185,8 @@
\param numBytes The number of bytes in \a bytes.
\see BListView::KeyDown()
\since BeOS R3
*/
@ -190,9 +195,7 @@
\brief Hook method called when a message is received by the outline list
view.
\param message The message received by the view.
\see BView::MessageReceived()
\copydetails BView::MessageReceived()
*/
@ -208,6 +211,8 @@
the mouse button is pressed.
\see BListView::MouseDown()
\since BeOS R3
*/
@ -216,9 +221,7 @@
\brief Hook method that is called when a mouse button is released while
the cursor is contained in the frame of the outline list view.
\param where The location that the mouse button was released.
\see BView::MouseUp()
\copydetails BView::MouseUp()
*/
@ -226,7 +229,7 @@
/*!
\name Add and remove item methods
\name Adding/Removing Items
*/
@ -241,6 +244,8 @@
\param superItem The item to add under, if \c NULL adds to end.
\return \c true if the \a item was added, \c false otherwise.
\since BeOS R3
*/
@ -251,6 +256,8 @@
\param item The \a item to add.
\return \c true if the \a item was added, \c false otherwise.
\since BeOS R3
*/
@ -262,6 +269,8 @@
\param fullListIndex The index to add \a item at.
\return \c true if the \a item was added, \c false otherwise.
\since BeOS R3
*/
@ -272,6 +281,8 @@
\param newItems The list of items to add.
\return \c true if the items was added, \c false otherwise.
\since BeOS R3
*/
@ -283,6 +294,8 @@
\param fullListIndex The index to add \a item at.
\return \c true if the items was added, \c false otherwise.
\since BeOS R3
*/
@ -293,6 +306,8 @@
\param item The \a item to remove.
\return \c true if the \a item was removed, \c false otherwise.
\since BeOS R3
*/
@ -301,6 +316,8 @@
\brief Removes the \a item located at \a fullListIndex from the list.
\return A pointer to the BListItem removed.
\since BeOS R3
*/
@ -309,6 +326,8 @@
\brief Removes \a count items starting at \a fullListIndex from the list.
\return \c true if the items were removed, \c false otherwise.
\since BeOS R3
*/
@ -316,7 +335,7 @@
/*!
\name Full list methods
\name Full List
These methods replicate similar methods in BListView except work on the
full list.
@ -334,6 +353,8 @@
found.
\see BListView::ItemAt(int32 index)
\since BeOS R3
*/
@ -344,6 +365,8 @@
\return The index of the item at \a where or -1 if not found.
\see BListView::IndexOf(BListItem* item)
\since BeOS R3
*/
@ -354,6 +377,8 @@
\return The index of the item at \a where or -1 if not found.
\see BListView::IndexOf(BPoint point)
\since BeOS R3
*/
@ -365,6 +390,8 @@
items.
\see BListView::FirstItem()
\since BeOS R3
*/
@ -376,6 +403,8 @@
items.
\see BListView::LastItem()
\since BeOS R3
*/
@ -388,6 +417,8 @@
\return \c true if \a item is in the list, \c false otherwise.
\see BListView::HasItem(BListItem* item)
\since BeOS R3
*/
@ -398,6 +429,8 @@
\return The number of items.
\see BListView::CountItems()
\since BeOS R3
*/
@ -410,12 +443,16 @@
index.
\see BListView::CurrentSelection(int32 index)
\since BeOS R3
*/
/*!
\fn void BOutlineListView::MakeEmpty()
\brief Empties the outline list view of all items.
\since BeOS R3
*/
@ -426,6 +463,8 @@
\return \c true if the outline list view is empty, \c false otherwise.
\see BListView::IsEmpty()
\since BeOS R3
*/
@ -436,6 +475,8 @@
\param func The function to call on each item.
\see BListView::DoForEach(bool (*func)(BListItem* item))
\since BeOS R3
*/
@ -449,6 +490,8 @@
\sa BListView::DoForEach(bool (*func)(BListItem* item, void* arg),
void* arg)
\since BeOS R3
*/
@ -461,18 +504,24 @@
\return A pointer to the superitem of \a item or \c NULL if the \a item
is at the outermost level or not found.
\since BeOS R3
*/
/*!
\fn void BOutlineListView::Expand(BListItem* item)
\brief Expands the section referenced by \a item.
\since BeOS R3
*/
/*!
\fn void BOutlineListView::Collapse(BListItem* item)
\brief Collapses the section referenced by \a item.
\since BeOS R3
*/
@ -482,11 +531,13 @@
is expanded or not.
\return \c true if the section is expanded, \c false if it is collapsed.
\since BeOS R3
*/
/*!
\name Sort methods
\name Sorting
*/
@ -501,6 +552,8 @@
\param compareFunc The compare function to use to sort the items.
\see BListView::SortItems(int (*cmp)(const void *, const void *))
\since BeOS R3
*/
@ -514,6 +567,8 @@
\param oneLevelOnly if \c true, only items located one level under
superItem are considered.
\param compareFunc The compare function to use to sort the items.
\since BeOS R3
*/
@ -530,6 +585,8 @@
superItem are considered.
\return The number of items under \a superItem.
\since BeOS R3
*/
@ -544,6 +601,8 @@
superItem are considered.
\param eachFunc The function to call on each item.
\param arg The second argument of \a eachFunc.
\since BeOS R3
*/
@ -563,6 +622,8 @@
\return A pointer to the item at \a index under \a superItem or \c NULL
if not found.
\since BeOS R3
*/
@ -575,6 +636,8 @@
\param data The \a data to act on.
\see BListView::DoMiscellaneous()
\since Haiku R1
*/
@ -585,6 +648,8 @@
\param item The \a item to toggle.
\param expand If \c true, expand the \a item, if \c false, collapse the
\a item.
\since Haiku R1
*/
@ -594,6 +659,8 @@
\param itemRect The area of the item to get the latch area of.
\param level The \a level of the item to get the latch area of.
\since Haiku R1
*/
@ -612,16 +679,20 @@
\c false to draw the latch in an unselected state. Unused
by the base class.
\param misTracked Unused by the base class.
\since Haiku R1
*/
/*!
\fn void BOutlineListView::DrawItem(BListItem* item, BRect itemRect,
bool complete)
\brief Used by derived classes to draw the \a item.
\brief Used by derived classes to override how an \a item is drawn.
\param item The \a item to draw.
\param itemRect The area of the \a item to draw.
\param complete Whether or not to draw the background in addition to the
contents.
\since Haiku R1
*/

33
docs/user/interface/Picture.dox
View File

@ -59,18 +59,24 @@
\sa BView::AppendToPicture()
\sa BView::BeginPicture()
\sa BView::EndPicture()
\since BeOS R3
*/
/*!
\fn BPicture::BPicture()
\brief Initializes an empty BPicture object.
\since BeOS R3
*/
/*!
\fn BPicture::BPicture(const BPicture& otherPicture)
\brief Initializes an BPicture object copying the data from \a otherPicture.
\since BeOS R3
*/
@ -78,15 +84,27 @@
\fn BPicture::BPicture(BMessage* data)
\brief Initializes an BPicture object copying the data from from the
passed in \a data archive.
\since BeOS R3
*/
/*!
\fn BPicture::~BPicture()
\brief Destroys the BPicture object and deletes all associated data.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BPicture::Instantiate(BMessage* data)
\brief Returns a pointer to a new BPicture object created from the BPicture
@ -96,6 +114,8 @@
contain an archived BPicture.
\see BArchivable::Instantiate()
\since BeOS R3
*/
@ -113,13 +133,20 @@
\sa BArchivable::Archive()
\sa BPicture::Instantiate()
\since BeOS R3
*/
//! @}
/*!
\fn status_t BPicture::Perform(perform_code code, void* arg)
\brief Perform some action (internal method defined for binary
compatibility purposes).
\since Haiku R1
*/
@ -139,6 +166,8 @@
\returns A status code.
\retval B_OK The BPicture object was played back successfully.
\retval B_ERROR BPicture data is \c NULL.
\since BeOS R3
*/
@ -153,6 +182,8 @@
\retval B_BAD_VALUE The \a stream pointer was \c NULL or the data was invalid.
\retval B_IO_ERROR The number of bytes written does not equal the size
of the contents of the BPicture object.
\since Haiku R1
*/
@ -167,4 +198,6 @@
\retval B_BAD_VALUE The \a stream pointer was \c NULL or the data was invalid.
\retval B_IO_ERROR The number of bytes read does not equal the size
of the contents of the BPicture object.
\since Haiku R1
*/

183
docs/user/interface/PictureButton.dox
View File

@ -24,6 +24,8 @@
Acts like a normal BButton, the value is set to \c B_CONTROL_ON when the
button is being pressed and is set to \c B_CONTROL_OFF otherwise.
\since BeOS R3
*/
@ -32,6 +34,8 @@
Acts like a checkbox, the value alternates between \c B_CONTROL_ON and
\c B_CONTROL_OFF each time the user presses and releases the button.
\since BeOS R3
*/
@ -40,6 +44,16 @@
\ingroup interface
\ingroup libbe
\brief A button draw with a BPicture image instead of a text label.
There are two types:
- \c B_ONE_STATE_BUTTON Acts like a normal BButton, the value is set to
\c B_CONTROL_ON when the button is being pressed and is set to
\c B_CONTROL_OFF otherwise.
- \c B_TWO_STATE_BUTTON Acts like a checkbox, the value alternates between
\c B_CONTROL_ON and \c B_CONTROL_OFF each time the user presses and
releases the button.
\since BeOS R3
*/
@ -64,6 +78,8 @@
\sa BPictureButton::SetEnabledOff()
\sa BPictureButton::SetDisabledOn()
\sa BPictureButton::SetDisabledOff()
\since BeOS R3
*/
@ -71,15 +87,27 @@
\fn BPictureButton::BPictureButton(BMessage* data)
\brief Initializes an BPictureButton object copying the data from from the
passed in \a data archive.
\since BeOS R3
*/
/*!
\fn BPictureButton::~BPictureButton()
\brief Destroys the BPictureButton along with the associated BPicture objects.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BPictureButton::Instantiate(BMessage* data)
\brief Returns a pointer to a new BPictureButton object created from the
@ -89,6 +117,8 @@
doesn't contain an archived BPictureButton.
\see BArchivable::Instantiate()
\since BeOS R3
*/
@ -106,78 +136,63 @@
\sa BArchivable::Archive()
\sa BPictureButton::Instantiate()
\since BeOS R3
*/
//! @}
/*!
\name Hook Methods
*/
//! @{
/*!
\fn void BPictureButton::AttachedToWindow()
\see BControl::AttachedToWindow()
\copydoc BControl::AttachedToWindow()
*/
/*!
\fn void BPictureButton::DetachedFromWindow()
\see BControl::DetachedFromWindow()
\copydoc BControl::DetachedFromWindow()
*/
/*!
\fn void BPictureButton::AllAttached()
\see BControl::AllAttached()
\copydoc BControl::AllAttached()
*/
/*!
\fn void BPictureButton::AllDetached()
\see BControl::AllDetached()
*/
/*!
\fn void BPictureButton::ResizeToPreferred()
\see BControl::ResizeToPreferred()
*/
/*!
\fn void BPictureButton::GetPreferredSize(float* _width, float* _height)
\see BControl::GetPreferredSize()
*/
/*!
\fn void BPictureButton::FrameMoved(BPoint newPosition)
\see BControl::FrameMoved()
*/
/*!
\fn BPictureButton::FrameResized(float newWidth, float newHeight)
\see BControl::FrameResized()
*/
/*!
\fn void BPictureButton::WindowActivated(bool state)
\see BControl::WindowActivated()
*/
/*!
\fn void BPictureButton::MakeFocus(bool state)
\see BControl::MakeFocus()
\copydoc BControl::AllDetached()
*/
/*!
\fn void BPictureButton::Draw(BRect updateRect)
\brief Draws the BPictureButton from its associated BPicture objects.
\copydetails BControl::Draw()
*/
/*!
\fn void BPictureButton::MessageReceived(BMessage* message)
\see BControl::MessageReceived()
\fn void BPictureButton::FrameMoved(BPoint newPosition)
\copydoc BControl::FrameMoved()
*/
/*!
\fn BPictureButton::FrameResized(float newWidth, float newHeight)
\copydoc BControl::FrameResized()
*/
@ -185,7 +200,13 @@
\fn void BPictureButton::KeyDown(const char* bytes, int32 numBytes)
\brief Invokes the button on either \c B_ENTER \c B_SPACE.
\sa BControl::KeyDown()
\copydetails BControl::KeyDown()
*/
/*!
\fn void BPictureButton::MessageReceived(BMessage* message)
\copydoc BControl::MessageReceived()
*/
@ -193,25 +214,52 @@
\fn void BPictureButton::MouseDown(BPoint where)
\brief Sets the button value based on the buttons Behavior().
\sa BControl::MouseDown()
\copydetails BControl::MouseDown()
\sa Behavior()
*/
/*!
\fn void BPictureButton::MouseMoved(BPoint where, uint32 code,
const BMessage* dragMessage)
\copydetails BControl::MouseMoved()
*/
/*!
\fn void BPictureButton::MouseUp(BPoint where)
\brief Invokes the button.
\sa BControl::MouseUp()
\copydetails BControl::MouseUp()
*/
/*!
\fn void BPictureButton::MouseMoved(BPoint where, uint32 transit,
const BMessage* message)
\brief
\fn void BPictureButton::WindowActivated(bool active)
\copydoc BControl::WindowActivated()
*/
\sa BControl::MouseMoved()
//! @}
/*!
\fn void BPictureButton::ResizeToPreferred()
\copydoc BControl::ResizeToPreferred()
*/
/*!
\fn void BPictureButton::GetPreferredSize(float* _width, float* _height)
\copydoc BControl::GetPreferredSize()
*/
/*!
\fn void BPictureButton::MakeFocus(bool focus)
\copydoc BControl::MakeFocus()
*/
@ -220,6 +268,8 @@
\brief Sets the BPicture to draw when the button is enabled and on.
\param picture A pointer to the BPicture object to set.
\since BeOS R3
*/
@ -228,6 +278,8 @@
\brief Sets the BPicture to draw when the button is enabled and off.
\param picture A pointer to the BPicture object to set.
\since BeOS R3
*/
@ -239,6 +291,8 @@
set because a disabled one-state control can never be on.
\param picture A pointer to the BPicture object to set.
\since BeOS R3
*/
@ -247,6 +301,8 @@
\brief Sets the BPicture to draw when the button is disabled and off.
\param picture A pointer to the BPicture object to set.
\since BeOS R3
*/
@ -256,6 +312,8 @@
is enabled and on.
\returns A pointer to a BPicture object or \c NULL if not set.
\since BeOS R3
*/
@ -265,6 +323,8 @@
is enabled and off.
\returns A pointer to a BPicture object or \c NULL if not set.
\since BeOS R3
*/
@ -274,6 +334,8 @@
is disabled and on.
\returns A pointer to a BPicture object or \c NULL if not set.
\since BeOS R3
*/
@ -283,6 +345,8 @@
is disabled and off.
\returns A pointer to a BPicture object or \c NULL if not set.
\since BeOS R3
*/
@ -298,6 +362,8 @@
the user presses and releases the button.
\param behavior Either \c B_ONE_STATE_BUTTON or \c B_TWO_STATE_BUTTON.
\since BeOS R3
*/
@ -307,43 +373,46 @@
\returns Either \c B_ONE_STATE_BUTTON or B_TWO_STATE_BUTTON.
\see BPictureButton::SetBehavior()
\see SetBehavior()
\since BeOS R3
*/
/*!
\fn void BPictureButton::SetValue(int32 value)
\see BControl::SetValue()
\copydoc BControl::SetValue()
*/
/*!
\fn status_t BPictureButton::Invoke(BMessage* message)
\see BControl::Invoke()
\copydoc BControl::Invoke()
*/
/*!
\fn BHandler* BPictureButton::ResolveSpecifier(BMessage* message,
int32 index, BMessage* specifier, int32 form, const char* property)
\see BControl::ResolveSpecifier()
int32 index, BMessage* specifier, int32 what, const char* property)
\copydoc BControl::ResolveSpecifier()
*/
/*!
\fn status_t BPictureButton::GetSupportedSuites(BMessage* data)
\see BControl::GetSupportedSuites()
\copydoc BControl::GetSupportedSuites()
*/
/*!
\fn status_t BPictureButton::Perform(perform_code code, void* _data)
\brief Perform some action (internal method defined for binary
compatibility purposes).
\copydoc BHandler::GetSupportedSuites()
*/
/*!
\fn status_t BPictureButton::SetIcon(const BBitmap* icon, uint32 flags)
\see BControl::SetIcon()
\since Haiku R1
*/

63
docs/user/interface/Point.dox
View File

@ -22,6 +22,8 @@
/*!
\var B_ORIGIN
\brief The origin point, equivalent to BPoint(0, 0).
\since BeOS R5
*/
@ -30,18 +32,24 @@
\ingroup interface
\ingroup libbe
\brief A point on a two-dimensional Cartesian coordinate system.
\since BeOS R3
*/
/*!
\var BPoint::x
\brief The horizontal coordinate.
\since BeOS R3
*/
/*!
\var BPoint::y
\brief The vertical coordinate.
\since BeOS R3
*/
@ -50,6 +58,8 @@
\brief Initializes a BPoint object at the origin, (0, 0).
\see BPoint::Set()
\since BeOS R3
*/
@ -60,6 +70,8 @@
\param x The \a x coordinate.
\param y The \a y coordinate.
\since BeOS R3
*/
@ -68,15 +80,8 @@
\brief Initializes a BPoint object from another BPoint.
\param other The BPoint object to copy from.
*/
/*!
\fn inline BPoint& BPoint::operator=(const BPoint& other)
\brief Initializes a BPoint object from another BPoint by overloading
the = operator.
\param other The BPoint object to copy from.
\since BeOS R3
*/
@ -86,6 +91,8 @@
\param x The \a x coordinate to set.
\param y The \a y coordinate to set.
\since BeOS R3
*/
@ -97,6 +104,8 @@
effect.
\param rect The BRect to constrain the BPoint within.
\since BeOS R3
*/
@ -109,6 +118,27 @@
\verbatim
BPoint(x:%.0f, y:%.0f)
\endverbatim
\since BeOS R3
*/
/*!
\name Operators
*/
//! @{
/*!
\fn inline BPoint& BPoint::operator=(const BPoint& other)
\brief Initializes a BPoint object from another BPoint by overloading
the = operator.
\param other The BPoint object to copy from.
\since BeOS R3
*/
@ -117,6 +147,8 @@ BPoint(x:%.0f, y:%.0f)
\brief Returns a BPoint object with the x and y coordinates negated.
\return A new BPoint object.
\since BeOS R3
*/
@ -128,6 +160,8 @@ BPoint(x:%.0f, y:%.0f)
\param other The BPoint object to use in the addition.
\return A new BPoint object.
\since BeOS R3
*/
@ -139,6 +173,8 @@ BPoint(x:%.0f, y:%.0f)
\param other The BPoint object to use in the subtraction.
\return A new BPoint object.
\since BeOS R3
*/
@ -150,6 +186,8 @@ BPoint(x:%.0f, y:%.0f)
\param other The BPoint object to use in the addition.
\return The address of the BPoint object.
\since BeOS R3
*/
@ -161,6 +199,8 @@ BPoint(x:%.0f, y:%.0f)
\param other The BPoint object to use in the subtraction.
\return The address of the BPoint object.
\since BeOS R3
*/
@ -170,6 +210,8 @@ BPoint(x:%.0f, y:%.0f)
objects differ.
\return \c true if the x or y coordinates differ, \c false otherwise.
\since BeOS R3
*/
@ -179,4 +221,9 @@ BPoint(x:%.0f, y:%.0f)
objects are equal.
\return \c true if the x and y coordinates are equal, \c false otherwise.
\since BeOS R3
*/
//! @}

26
docs/user/interface/Polygon.dox
View File

@ -36,6 +36,8 @@
\sa BView::StrokePolygon()
\sa BView::FillPolygon()
\since BeOS R3
*/
@ -45,6 +47,8 @@
\param points The array of BPoint objects to add.
\param count The number of BPoint objects in the array.
\since BeOS R3
*/
@ -53,9 +57,9 @@
\brief Initializes a new BPolygon object from another BPolygon and
copies the list of BPoint objects from \a other.
\note This method was not available in BeOS R5.
\param other The BPolygon object to copy from.
\since Haiku R1
*/
@ -65,6 +69,8 @@
BPolygon and copies the list of BPoint objects from \a other.
\param other A pointer to a BPolygon object to copy from.
\since BeOS R3
*/
@ -73,6 +79,8 @@
\brief Initializes an empty polygon without any points.
\see BPolygon::AddPoints() to add points to the BPolygon.
\since BeOS R3
*/
@ -80,6 +88,8 @@
\fn BPolygon::~BPolygon()
\brief Destroys the object and frees the memory used by the associated
BPoint objects.
\since BeOS R3
*/
@ -89,12 +99,16 @@
objects from \a other.
\param other The BPolygon object to copy from.
\since BeOS R3
*/
/*!
\fn BRect BPolygon::Frame() const
\brief Returns the frame rectangle that encloses the BPolygon object.
\since BeOS R3
*/
@ -104,12 +118,16 @@
\param points The array of BPoint objects to add.
\param count The number of BPoint objects in the array.
\since BeOS R3
*/
/*!
\fn int32 BPolygon::CountPoints() const
\brief Returns the number of points associated with the polygon.
\since BeOS R3
*/
@ -122,6 +140,8 @@
proportionally. To modify a polygon so that it is inscribed in the
\a destination rectangle exactly, pass the frame rectangle as the
\a source.
\since BeOS R3
*/
@ -130,4 +150,6 @@
\brief Prints each of the points of the BPolygon to standard output.
\see BPoint::PrintToStream()
\since BeOS R3
*/

55
docs/user/interface/PopUpMenu.dox
View File

@ -48,6 +48,8 @@
If the pop-up menu is used as part of a BMenuField or BMenuBar it behaves
almost exactly like a BMenu would, but, the menu pops up directly under the
mouse pointer instead of underneath the BMenuBar or BMenuField.
\since BeOS R3
*/
@ -72,6 +74,8 @@
\see BMenu::SetRadioMode()
\see BMenu::SetLabelFromMarked()
\since BeOS R3
*/
@ -80,6 +84,20 @@
\brief Archive constructor.
\param archive The message data to construct the pop-up menu from.
\since BeOS R3
*/
/*!
\fn BPopUpMenu& BPopUpMenu::operator=(const BPopUpMenu& other)
\brief Assignment overload method.
\param other The BPopUpMenu object to assign from.
\return The newly assigned BPopUpMenu object.
\since BeOS R3
*/
@ -88,9 +106,19 @@
\brief Destructor method.
Also frees the memory used by any attached menu items.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn status_t BPopUpMenu::Archive(BMessage* data, bool deep) const
\brief Archives the the BMenuField object into the \a data message.
@ -102,6 +130,8 @@
otherwise.
\retval B_OK The object was archived successfully.
\retval B_NO_MEMORY Ran out of memory while archiving the object.
\since BeOS R3
*/
@ -111,9 +141,14 @@
\returns A newly created BPopUpMenu object or \c NULL if the message
doesn't contain an archived BPopUpMenu.
\since BeOS R3
*/
//! @}
/*!
\fn BMenuItem* BPopUpMenu::Go(BPoint where, bool deliversMessage,
bool openAnyway, bool async)
@ -132,6 +167,8 @@
\c false the menu will not return until a menu item is selected
or it is dismissed by the user. If a menu item was selected a
pointer to the menu item is returned, if not, \c NULL is returned.
\since BeOS R3
*/
@ -161,6 +198,8 @@
\c false the menu will not return until a menu item is selected
or it is dismissed by the user. If a menu item was selected a
pointer to the menu item is returned, if not, \c NULL is returned.
\since BeOS R3
*/
@ -171,6 +210,8 @@
\param on \c true to turn async-auto-destruct mode on, \c false to turn
async-auto-destruct mode off.
\since BeOS R5
*/
@ -182,6 +223,8 @@
async-auto-destruct mode is turned off.
\see SetAsyncAutoDestruct()
\since BeOS R5
*/
@ -195,14 +238,6 @@
\returns The location that the pop-up-menu will appear on screen in the
screen's coordinate system.
*/
/*!
\fn BPopUpMenu& BPopUpMenu::operator=(const BPopUpMenu& other)
\brief Assignment overload method.
\param other The BPopUpMenu object to assign from.
\return The newly assigned BPopUpMenu object.
\since BeOS R3
*/

159
docs/user/interface/RadioButton.dox
View File

@ -40,6 +40,8 @@
determine what action takes place when each radio button is selected, if
any. The message is sent only when a radio button is turned on, not when
it is turned off.
\since BeOS R3
*/
@ -64,6 +66,8 @@
\param resizingMode Defines the behavior of the radio button as the parent
view resizes. See BView for details.
\param flags Behavior flags for the radio button. See BView for details.
\since BeOS R3
*/
@ -81,6 +85,8 @@
\param message The \a message to send when the radio button is activated,
can be \c NULL.
\param flags Behavior flags for the checkbox. See BView for details.
\since Haiku R1
*/
@ -96,6 +102,8 @@
can be \c NULL.
\param message The \a message to send when the radio button is activated,
can be \c NULL.
\since Haiku R1
*/
@ -108,12 +116,16 @@
instead because it can handle errors properly.
\param archive The message to construct the BRadioButton object from.
\since BeOS R3
*/
/*!
\fn BRadioButton::~BRadioButton()
\brief Destructor, does nothing.
\since BeOS R3
*/
@ -131,6 +143,8 @@
\return A newly created radio button or \c NULL if the message doesn't
contain an archived BRadioButton.
\since BeOS R3
*/
@ -145,6 +159,8 @@
otherwise.
\sa BControl::Archive()
\since BeOS R3
*/
@ -159,13 +175,23 @@
//! @{
/*!
\fn void BRadioButton::AllAttached()
\copydoc BView::AllAttached()
*/
/*!
\fn void BRadioButton::AllDetached()
\copydoc BView::AllDetached()
*/
/*!
\fn void BRadioButton::AttachedToWindow()
\brief Hook method called when the control is attached to a window.
The default implementation does nothing.
\sa BControl::AttachedToWindow()
\copydetails BControl::AttachedToWindow()
*/
@ -173,31 +199,7 @@
\fn void BRadioButton::DetachedFromWindow()
\brief Hook method called when the control is detached from a window.
The default implementation does nothing.
\sa BControl::DetachedFromWindow()
*/
/*!
\fn void BRadioButton::AllAttached()
\brief Similar to AttachedToWindow() but this method is triggered after
all child views have already been attached to a window.
The default implementation does nothing.
\sa BView::AllAttached()
*/
/*!
\fn void BRadioButton::AllDetached()
\brief Similar to AttachedToWindow() but this method is triggered after
all child views have already been detached from a window.
The default implementation does nothing.
\sa BView::AllDetached()
\copydetails BControl::DetachedFromWindow()
*/
@ -212,6 +214,8 @@
\param updateRect The rectangular area to be drawn.
\sa BView::Draw()
\since BeOS R3
*/
@ -219,24 +223,15 @@
\fn void BRadioButton::FrameMoved(BPoint newPosition)
\brief Hook method called when the radio button is moved.
The default implementation does nothing.
\param newPosition The point that the radio button has been moved to.
\sa BView::FrameMoved()
\copydetails BView::FrameMoved()
*/
/*!
\fn void BRadioButton::FrameResized(float width, float height)
\fn void BRadioButton::FrameResized(float newWidth, float newHeight)
\brief Hook method called when the radio button is resized.
The default implementation does nothing.
\param width The new \a width of the radio button.
\param height The new \a height of the radio button.
\sa BView::FrameResized()
\copydetails BView::FrameResized()
*/
@ -247,8 +242,7 @@
Overrides \c B_RETURN and \c B_SPACE from BControl to toggle the value,
but don't allow turning the control off, only on.
\param bytes The bytes of the key combination pressed.
\param numBytes The number of bytes in \a bytes.
\copydetails BControl::KeyDown()
*/
@ -256,11 +250,7 @@
\fn void BRadioButton::MessageReceived(BMessage* message)
\brief Handle \a message received by the associated looper.
The default implemenation does nothing.
\param message The \a message received by the associated looper.
\see BControl::MessageReceived()
\copydetails BControl::MessageReceived()
*/
@ -270,8 +260,7 @@
Begins tracking the mouse cursor.
\param where The point on the screen where to mouse pointer is when
the mouse button is pressed.
\copydetails BControl::MouseDown()
*/
@ -283,19 +272,7 @@
Once MouseDown() has been called on a radio button this method updates
the outline when the cursor is inside the control redrawing as necessary.
\param where The new location of the mouse in the control's coordinate system.
\param code One of the following:
- \c B_ENTERED_VIEW The cursor has just entered the control.
- \c B_INSIDE_VIEW The cursor is inside the control.
- \c B_EXITED_VIEW The cursor has left the control's bounds. This only gets
sent if the scope of the mouse events that the control can receive has
been expanded by BView::SetEventMask() or BView::SetMouseEventMask().
- \c B_OUTSIDE_VIEW The cursor is outside the button. This only gets sent if
the scope of the mouse events that the control can receive has been
expanded by SetEventMask() or SetMouseEventMask().
\param dragMessage If a drag-and-drop operation is taking place this is a
pointer to a BMessage that holds the drag information, otherwise the
pointer is \c NULL.
\copydetails BControl::MouseMoved()
*/
@ -307,10 +284,7 @@
Invoke() method. Unlike a BCheckBox, a BRadioButton only posts its message when
it is turned on, not when it is turned off.
\param where The point on the screen where the mouse pointer is located when
the mouse button is released in the view's coordinate system.
\sa BControl::MouseUp()
\copydetails BControl::MouseUp()
*/
@ -319,12 +293,7 @@
\brief Hook method called when the attached window is activated or
deactivated.
The default implementation does nothing.
\param active \c true if the window becomes activated, \c false if the
window becomes deactivated.
\sa BControl::WindowActivated()
\copydetails BControl::WindowActivated()
*/
@ -332,26 +301,18 @@
/*!
\fn void BRadioButton::MakeFocus(bool focused)
\fn void BRadioButton::MakeFocus(bool focus)
\brief Makes the radio button the current focus view of the window or
gives up being the window's focus view.
The default implementation does nothing.
\param focused \a true to set focus, \a false to remove it.
\sa BControl::MakeFocus()
\copydetails BControl::MakeFocus()
*/
/*!
\fn BHandler* BRadioButton::ResolveSpecifier(BMessage* message,
int32 index, BMessage* specifier, int32 what, const char* property)
\brief Determine the proper specifier for scripting messages.
The default implementation does nothing.
\sa BControl::ResolveSpecifier()
\copydoc BHandler::ResolveSpecifier()
*/
@ -362,10 +323,7 @@
Turning a radio button on turns off all sibling radio buttons and calls the
Invoke() method.
\param value The value to set the radio button to, should be
either \c B_CONTROL_ON or \c B_CONTROL_OFF.
\sa BControl::SetValue()
\copydetails BControl::SetValue()
*/
@ -379,35 +337,28 @@
\param[out] _width Pointer to a \c float to store the width.
\param[out] _height Pointer to a \c float to store the height.
\since BeOS R3
*/
/*!
\fn status_t BRadioButton::GetSupportedSuites(BMessage* message)
\brief Report the suites of messages this control understands.
\param message Allows you to add the names of the suites the radio button
implements to the suites array.
\return \c B_OK if all went well or an error code otherwise.
\sa BControl::GetSupportedSuites();
\copydoc BControl::GetSupportedSuites();
*/
/*!
\fn status_t BRadioButton::Invoke(BMessage* message)
\brief Sends a copy of the model \a message to the designated target.
The default implementation does nothing.
\sa BControl::Invoke()
\copydoc BControl::Invoke()
*/
/*!
\fn status_t BRadioButton::Perform(perform_code code, void* _data)
\brief Perform some action. (Internal Method)
\since Haiku R1
*/
@ -416,6 +367,8 @@
\brief Returns the alignment used by this control in a layout.
\return The alignment used by this control as a BAlignment.
\since Haiku R1
*/
@ -426,6 +379,8 @@
\return The maximum size of the radio button as a BSize.
\sa BAbstractLayout::MaxSize()
\since Haiku R1
*/
@ -436,6 +391,8 @@
The default implementation does nothing.
\sa BControl::ResizeToPreferred()
\since BeOS R3
*/
@ -444,4 +401,6 @@
\brief Set the icon used by the radio button.
\see BControl::SetIcon()
\since Haiku R1
*/

143
docs/user/interface/Rect.dox
View File

@ -49,30 +49,40 @@ BRect(0, 0, 31, 31);
\code
BRect(0, 0, width - 1, height -1);
\endcode
\since BeOS R3
*/
/*!
\var BRect::left
\brief The value of the rectangle's left edge.
\since BeOS R3
*/
/*!
\var BRect::top
\brief The value of the rectangle's top edge.
\since BeOS R3
*/
/*!
\var BRect::right
\brief The value of the rectangle's right edge.
\since BeOS R3
*/
/*!
\var BRect::bottom
\brief The value of the rectangle's bottom edge.
\since BeOS R3
*/
@ -84,6 +94,8 @@ BRect(0, 0, width - 1, height -1);
\sa BRect::Set()
\sa BRect::IsValid()
\since BeOS R3
*/
@ -95,6 +107,8 @@ BRect(0, 0, width - 1, height -1);
\param top The top dimension.
\param right The right dimension.
\param bottom The bottom dimension.
\since BeOS R3
*/
@ -103,6 +117,8 @@ BRect(0, 0, width - 1, height -1);
\brief Creates a new BRect object as a copy of \a other.
\param other The BRect object to copy.
\since BeOS R3
*/
@ -113,6 +129,8 @@ BRect(0, 0, width - 1, height -1);
\param leftTop The position to set the left top corner to.
\param rightBottom The position to set the bottom right corner to.
\since BeOS R3
*/
@ -123,6 +141,8 @@ BRect(0, 0, width - 1, height -1);
\param leftTop The position of the left top corner.
\param size The \a size of the rect defining its width and height.
\since Haiku R1
*/
@ -132,17 +152,8 @@ BRect(0, 0, width - 1, height -1);
to 0 and setting the right and bottom dimensions to \a side - 1.
\param side The dimension to set the right and bottom sides.
*/
/*!
\fn inline BRect& BRect::operator=(const BRect& other)
\brief Creates a new BRect object as a copy of \a other by overloading
the = operator.
\param other The BRect object to copy.
\return The newly created BRect object.
\since Haiku R1
*/
@ -155,6 +166,8 @@ BRect(0, 0, width - 1, height -1);
is greater than or equal to its top value.
\return \c true if the BRect is valid, \c false if the BRect is invalid.
\since BeOS R3
*/
@ -165,6 +178,8 @@ BRect(0, 0, width - 1, height -1);
\param rect The BRect to use to test for intersection.
\return \c true if the rectangles intersect, \a false otherwise.
\since BeOS R3
*/
@ -175,6 +190,8 @@ BRect(0, 0, width - 1, height -1);
\param point The point to test.
\return \c true if the BRect contains \a point, \c false otherwise.
\since BeOS R3
*/
@ -185,6 +202,8 @@ BRect(0, 0, width - 1, height -1);
\param rect The rectangle to test.
\return \c true if the BRect contains \a rect, \c false otherwise.
\since BeOS R3
*/
@ -196,6 +215,8 @@ BRect(0, 0, width - 1, height -1);
\verbatim
BRect(l:%.1f, t:%.1f, r:%.1f, b:%.1f).
\endverbatim
\since BeOS R3
*/
@ -205,6 +226,8 @@ BRect(0, 0, width - 1, height -1);
ceil(\a right - \a left).
\return The width of the rectangle as an int32.
\since BeOS R3
*/
@ -222,6 +245,8 @@ BRect(0, 0, width - 1, height -1);
ceil(\a bottom - \a top).
\return The height of the rectangle as an int32.
\since BeOS R3
*/
@ -230,6 +255,8 @@ BRect(0, 0, width - 1, height -1);
\brief Returns the height of the rectangle.
\return The height of the rectangle as a float.
\since BeOS R3
*/
@ -238,6 +265,8 @@ BRect(0, 0, width - 1, height -1);
\brief Returns the dimensions of the BRect.
\return The dimensions of the BRect as a BSize.
\since Haiku R1
*/
@ -250,6 +279,8 @@ BRect(0, 0, width - 1, height -1);
\param top The \a top dimension to set.
\param right The \a right dimension to set.
\param bottom The \a bottom dimension to set.
\since BeOS R3
*/
@ -258,6 +289,8 @@ BRect(0, 0, width - 1, height -1);
\brief Sets the left top \a point of the BRect.
\param point The \a point to set.
\since BeOS R3
*/
@ -266,6 +299,8 @@ BRect(0, 0, width - 1, height -1);
\brief Sets the right bottom \a point of the BRect.
\param point The \a point to set.
\since BeOS R3
*/
@ -274,6 +309,8 @@ BRect(0, 0, width - 1, height -1);
\brief Sets the left bottom \a point of the BRect.
\param point The \a point to set.
\since BeOS R3
*/
@ -282,6 +319,8 @@ BRect(0, 0, width - 1, height -1);
\brief Sets the right top \a point of the BRect.
\param point The \a point to set.
\since BeOS R3
*/
@ -290,6 +329,8 @@ BRect(0, 0, width - 1, height -1);
\brief Returns the left top point of the BRect.
\return The left top point as a BPoint.
\since BeOS R3
*/
@ -298,6 +339,8 @@ BRect(0, 0, width - 1, height -1);
\brief Returns the right bottom point of the BRect.
\return The right bottom point as a BPoint.
\since BeOS R3
*/
@ -306,6 +349,8 @@ BRect(0, 0, width - 1, height -1);
\brief Returns the left bottom point of the BRect.
\return The left bottom point as a BPoint.
\since BeOS R3
*/
@ -314,11 +359,13 @@ BRect(0, 0, width - 1, height -1);
\brief Returns the right top point of the BRect.
\return The left right point as a BPoint.
\since BeOS R3
*/
/*!
\name Transformation methods
\name Transformation
Positive values make the rectangle smaller, negative values make it larger.
@ -335,6 +382,8 @@ BRect(0, 0, width - 1, height -1);
\brief Inset the BRect by the x and y coordinates of \a point.
\param point The \a point to use to inset the BRect.
\since BeOS R3
*/
@ -345,6 +394,8 @@ BRect(0, 0, width - 1, height -1);
\param dx The horizontal distance to inset the BRect by.
\param dy The vertical distance to inset the BRect by.
\since BeOS R3
*/
@ -357,6 +408,8 @@ BRect(0, 0, width - 1, height -1);
\return The transformed BRect.
\sa BRect::InsetBy(BPoint point)
\since BeOS R5
*/
@ -370,6 +423,8 @@ BRect(0, 0, width - 1, height -1);
\return The transformed BRect.
\sa BRect::InsetBy(float dx, float dy)
\since BeOS R5
*/
@ -383,6 +438,8 @@ BRect(0, 0, width - 1, height -1);
\return A copy of the BRect after it has been transformed.
\sa BRect::InsetBy(BPoint point)
\since BeOS R5
*/
@ -397,6 +454,8 @@ BRect(0, 0, width - 1, height -1);
\return A copy of the BRect after it has been transformed.
\sa BRect::InsetBy(float dx, float dy)
\since BeOS R5
*/
@ -404,7 +463,7 @@ BRect(0, 0, width - 1, height -1);
/*!
\name Translation methods
\name Translation
Positive values move the rectangle right and down, negative values move the
rectangle left and up.
@ -424,6 +483,8 @@ BRect(0, 0, width - 1, height -1);
of the rectangle.
\param point The \a point to use to move the rectangle.
\since BeOS R3
*/
@ -434,6 +495,8 @@ BRect(0, 0, width - 1, height -1);
\param dx The number of units the move the rectangle vertically.
\param dy The number of units the move the rectangle horizontally.
\since BeOS R3
*/
@ -444,6 +507,8 @@ BRect(0, 0, width - 1, height -1);
\param point The \a point to use to move the rectangle.
\sa BRect::OffsetBy(BPoint point)
\since BeOS R5
*/
@ -457,6 +522,8 @@ BRect(0, 0, width - 1, height -1);
\return The translated BRect.
\sa BRect::OffsetBy(float dx, float dy)
\since BeOS R5
*/
@ -470,6 +537,8 @@ BRect(0, 0, width - 1, height -1);
\return A copy of the BRect after it has been translated.
\sa BRect::OffsetBy(BPoint point)
\since BeOS R5
*/
@ -484,6 +553,8 @@ BRect(0, 0, width - 1, height -1);
\return A copy of the BRect after it has been translated.
\sa BRect::OffsetBy(float dx, float dy)
\since BeOS R5
*/
@ -492,6 +563,8 @@ BRect(0, 0, width - 1, height -1);
\brief Move the BRect to the location specified by \a point.
\param point The location to move the BRect to.
\since BeOS R3
*/
@ -502,6 +575,8 @@ BRect(0, 0, width - 1, height -1);
\param x The vertical coordinate of the point to move the BRect to.
\param y The horizontal coordinate of the point to move the BRect to.
\since BeOS R3
*/
@ -514,6 +589,8 @@ BRect(0, 0, width - 1, height -1);
\return The translated BRect.
\sa BRect::OffsetTo(BPoint point)
\since BeOS R5
*/
@ -527,6 +604,8 @@ BRect(0, 0, width - 1, height -1);
\return The translated BRect.
\sa BRect::OffsetTo(float x, float y)
\since BeOS R5
*/
@ -540,13 +619,15 @@ BRect(0, 0, width - 1, height -1);
\return A copy of the BRect after it has been translated.
\sa BRect::OffsetTo(BPoint point)
\since BeOS R5
*/
/*!
\fn BRect BRect::OffsetToCopy(float x, float y) const
\brief Like BRect::OffsetTo() but returns a copy of the translated
BRect leaving the original unmodified.
BRect leaving the original unmodified.
\param x The number of units the move the rectangle vertically.
\param y The number of units the move the rectangle horizontally.
@ -554,6 +635,8 @@ BRect(0, 0, width - 1, height -1);
\return A copy of the BRect after it has been translated.
\sa BRect::OffsetTo(float x, float y)
\since BeOS R5
*/
@ -561,13 +644,26 @@ BRect(0, 0, width - 1, height -1);
/*!
\name Comparison methods
\name Operators
*/
//! @{
/*!
\fn inline BRect& BRect::operator=(const BRect& other)
\brief Creates a new BRect object as a copy of \a other by overloading
the = operator.
\param other The BRect object to copy.
\return The newly created BRect object.
\since BeOS R3
*/
/*!
\fn bool BRect::operator==(BRect other) const
\brief Returns whether or not two rectangles coincide exactly.
@ -575,6 +671,8 @@ BRect(0, 0, width - 1, height -1);
\param other The BRect to compare with.
\return \c true if the rectangles coincide, \c false otherwise.
\since BeOS R3
*/
@ -585,20 +683,11 @@ BRect(0, 0, width - 1, height -1);
\param other The BRect to compare with.
\return \c true if the rectangles do NOT coincide, \c false otherwise.
\since BeOS R3
*/
//! @}
/*!
\name Intersection and union methods
*/
//! @{
/*!
\fn BRect BRect::operator&(BRect other) const
\brief Returns a new BRect that is the intersection of the BRect and
@ -609,6 +698,8 @@ BRect(0, 0, width - 1, height -1);
\param other The BRect to take the intersection of.
\return A new BRect that is the intersection of the BRect and \a other.
\since BeOS R3
*/
@ -621,6 +712,8 @@ BRect(0, 0, width - 1, height -1);
\param other The BRect to take the union of.
\return A new BRect that is the union of the BRect and \a other.
\since BeOS R3
*/

110
docs/user/interface/Region.dox
View File

@ -31,6 +31,8 @@
clipping masks.
\warning BRegion is designed to be used with integral coordinates only.
\since BeOS R3
*/
@ -38,6 +40,8 @@
\fn BRegion::BRegion()
\brief Initializes an empty region. The region contains no rectangles,
and its bounds are invalid.
\since BeOS R3
*/
@ -46,6 +50,8 @@
\brief Initializes a region as a copy of \a other.
\param other The region to copy.
\since BeOS R3
*/
@ -54,6 +60,8 @@
\brief Initializes a region to contain a \a rect.
\param rect The BRect to add to the region.
\since BeOS R5
*/
@ -63,15 +71,27 @@
\param clipping The clipping_rect to set the region to, already in
internal rect format.
\since Haiku R1
*/
/*!
\fn BRegion::~BRegion()
\brief Destroys the BRegion freeing any memory allocated by it.
\since BeOS R3
*/
/*!
\name Operators
*/
//! @{
/*!
\fn BRegion& BRegion::operator=(const BRegion& other)
\brief Modifies the BRegion to be a copy of \a other.
@ -79,6 +99,8 @@
\param other the BRegion to copy.
\return This method always returns \c *this.
\since BeOS R3
*/
@ -89,30 +111,41 @@
\param other the BRegion to compare to.
\return \c true if the regions are the same, \c false otherwise.
\since BeOS R3
*/
//! @}
/*!
\fn void BRegion::Set(BRect newBounds)
\fn void BRegion::Set(BRect rect)
\brief Set the region to bounds of \a newBounds.
\param newBounds The BRect to set the bounds to.
\param rect The BRect to set the bounds to.
\since BeOS R3
*/
/*!
\fn void BRegion::Set(clipping_rect newBounds)
\fn void BRegion::Set(clipping_rect clipping)
\brief Set the region to the bounds of \a clipping_rect.
\param newBounds The clipping_rect to set the bounds to.
\param clipping The clipping_rect to set the bounds to.
\since Haiku R1
*/
/*!
\fn BRect BRegion::Frame() const
\brief Returns the region's bounds.
\brief Returns a rectangle that encloses the BRegion.
\return A BRect which represents the region's bounds.
\return A BRect that encloses the BRegion.
\since BeOS R3
*/
@ -122,6 +155,8 @@
(which has integer coordinates).
\return The clipping_rect which represents the region's bounds.
\since Haiku R1
*/
@ -133,6 +168,8 @@
\return If the given index is valid, it returns the BRect at that index,
otherwise, it returns an invalid BRect.
\since BeOS R3
*/
@ -144,6 +181,8 @@
\return If the given index is valid, it returns the BRect at that index,
otherwise, it returns an invalid BRect.
\since Haiku R1
*/
@ -156,6 +195,8 @@
\return If the given index is valid, it returns the clipping_rect at that
index, otherwise, it returns an invalid clipping_rect.
\since Haiku R1
*/
@ -168,6 +209,8 @@
\return If the given index is valid, it returns the clipping_rect at that
index, otherwise, it returns an invalid clipping_rect.
\since Haiku R1
*/
@ -176,6 +219,8 @@
\brief Returns the number of rectangles contained in the region.
\return The number of rectangles in the region as an int32.
\since BeOS R3
*/
@ -184,6 +229,8 @@
\brief Returns the number of rectangles contained in the region.
\return The number of rectangles in the region as an int32.
\since Haiku R1
*/
@ -196,6 +243,8 @@
\return \c true if the region has any area in common with the BRect,
\c false if not.
\since BeOS R3
*/
@ -208,6 +257,8 @@
\return \c true if the region has any area in common with the
clipping_rect, \c false if not.
\since Haiku R1
*/
@ -218,6 +269,8 @@
\param point The \a point to check.
\return \c true if the region contains the \a point, \c false if not.
\since BeOS R3
*/
@ -229,6 +282,8 @@
\param y The \c y coordinate of the point to check.
\return \c true if the region contains the point, \c false if not.
\since Haiku R1
*/
@ -240,12 +295,16 @@
\param y The \c y coordinate of the point to check.
\return \c true if the region contains the point, \c false if not.
\since Haiku R1
*/
/*!
\fn void BRegion::PrintToStream() const
\brief Prints each rect in the the BRegion to standard output.
\since BeOS R3
*/
@ -256,6 +315,8 @@
the region's bounds.
\param point The point to get the coordinates to offset by.
\since Haiku R1
*/
@ -266,6 +327,8 @@
\param x The horizontal offset.
\param y The vertical offset.
\since BeOS R3
*/
@ -273,6 +336,8 @@
\fn void BRegion::MakeEmpty()
\brief Empties the region so that it doesn't containt any rects, and
invalidates its bounds.
\since BeOS R3
*/
@ -281,6 +346,8 @@
\brief Modifies the region so that it includes the given \a rect.
\param rect The BRect to include in the region.
\since BeOS R3
*/
@ -290,6 +357,8 @@
rectangle.
\param clipping The clipping_rect to include in the region.
\since Haiku R1
*/
@ -298,6 +367,8 @@
\brief Modifies the region to include the area of the given \a region.
\param region The \a region to be included.
\since BeOS R3
*/
@ -306,6 +377,8 @@
\brief Modifies the region excluding the area of the given \a rect.
\param rect The BRect to be excluded.
\since BeOS R3
*/
@ -315,6 +388,8 @@
rectangle.
\param clipping The clipping_rect to be excluded.
\since Haiku R1
*/
@ -324,6 +399,8 @@
\a region.
\param region The BRegion to be excluded.
\since BeOS R3
*/
@ -333,6 +410,8 @@
in common with \a region.
\param region the BRegion to intersect with.
\since BeOS R3
*/
@ -342,21 +421,6 @@
which the BRegion and \a region do NOT have in common.
\param region the BRegion to exclusively include.
*/
/*!
\fn void BRegion::_AdoptRegionData(BRegion& region)
\brief Takes over the data of \a region and empties it.
\param region The \a region to adopt data from.
*/
/*!
\fn bool BRegion::_SetSize(int32 newSize)
\brief Reallocate the memory in the region.
\param newSize The amount of rectangles that the region should be
able to hold.
\since Haiku R1
*/

200
docs/user/interface/Screen.dox
View File

@ -26,7 +26,7 @@
\ingroup interface
\ingroup libbe
\brief The BScreen class provides methods to retrieve and change display
settings.
settings.
Each BScreen object describes one display connected to the computer.
Multiple BScreen objects can represent the same physical display.
@ -66,42 +66,50 @@
monitor into a low-power mode. Call DPMSCapabilites() to check what
modes are supported by your monitor. DPMSState() tells you what state
your monitor is currently in and SetDPMS() allows you to change it.
\since BeOS R3
*/
/*!
\fn BScreen::BScreen(screen_id id)
\brief Creates a BScreen object which represents the display
connected to the computer with the given screen_id.
connected to the computer with the given screen_id.
In the current implementation, there is only one display
(\c B_MAIN_SCREEN_ID). To be sure that the object was constructed
correctly, call IsValid().
\param id The screen_id of the screen to create a BScreen object from.
\since BeOS R3
*/
/*!
\fn BScreen::BScreen(BWindow* window)
\brief Creates a BScreen object which represents the display that
contains \a window.
contains \a window.
In the current implementation, there is only one display
(\c B_MAIN_SCREEN_ID). To be sure that the object was constructed
correctly, call IsValid().
\param window A BWindow object.
\since BeOS R3
*/
/*!
\fn BScreen::~BScreen()
\brief Frees the resources used by the BScreen object and unlocks the
screen.
screen.
\note The main screen object will never go away, even if you disconnect
all monitors.
all monitors.
\since BeOS R3
*/
@ -116,9 +124,11 @@
/*!
\fn bool BScreen::IsValid()
\brief Checks that the BScreen object represents a real display that is
connected to the computer.
connected to the computer.
\return \c true if the BScreen object is valid, \c false otherwise.
\since BeOS R3
*/
@ -127,15 +137,19 @@
\brief Sets the BScreen object to the next display in the screen list.
\return \c B_OK if successful, otherwise \c B_ERROR.
\since BeOS R5
*/
/*!
\fn color_space BScreen::ColorSpace()
\brief Gets the color_space of the display.
\brief Returns the color_space of the display.
\return \c B_CMAP8, \c B_RGB15, \c B_RGB32, or \c B_NO_COLOR_SPACE
if the BScreen object is invalid.
if the BScreen object is invalid.
\since BeOS R3
*/
@ -151,6 +165,8 @@
You can set the frame programmatically by calling the SetMode() method.
\return a BRect frame of the screen in the screen's coordinate system.
\since BeOS R3
*/
@ -162,6 +178,8 @@
even if the object is invalid.
\return A screen_id that identifies the screen.
\since BeOS R3
*/
@ -170,18 +188,22 @@
\brief Blocks until the monitor has finished its current vertical retrace.
\return \c B_OK or \c B_ERROR if the screen object is invalid.
\since BeOS R3
*/
/*!
\fn status_t BScreen::WaitForRetrace(bigtime_t timeout)
\brief Blocks until the monitor has finished its current vertical retrace
or until \a timeout has expired.
or until \a timeout has expired.
\param timeout The amount of time to wait before returning.
\return \c B_OK if the monitor has retraced in the given \a timeout
duration, \c B_ERROR otherwise.
duration, \c B_ERROR otherwise.
\since BeOS R5
*/
@ -189,7 +211,7 @@
/*!
\name Color Methods
\name Color
*/
@ -198,20 +220,22 @@
/*!
\fn inline uint8 BScreen::IndexForColor(rgb_color color)
\brief Gets the 8-bit color index that most closely matches a
32-bit \a color.
\brief Returns the 8-bit color index that most closely matches a
32-bit \a color.
\param color The 32-bit \a color to get the 8-bit index of.
\return An 8-bit color index in the screen's color_map.
\since BeOS R3
*/
/*!
\fn uint8 BScreen::IndexForColor(uint8 red, uint8 green, uint8 blue,
uint8 alpha)
\brief Gets the 8-bit color index that most closely matches a set of
\a red, \a green, \a blue, and \a alpha values.
uint8 alpha)
\brief Returns the 8-bit color index that most closely matches a set of
\a red, \a green, \a blue, and \a alpha values.
\param red The \a red value.
\param green The \a green value.
@ -219,6 +243,8 @@
\param alpha The \a alpha value.
\return An 8-bit color index in the screen's color_map.
\since BeOS R3
*/
@ -229,6 +255,8 @@
\param index The 8-bit color \a index to convert to a 32-bit color.
\return A 32-bit rgb_color structure.
\since BeOS R3
*/
@ -241,7 +269,9 @@
\param index The 8-bit color \a index.
\return An 8-bit color \a index that represents the "Inversion" of the
given color in the screen's color_map.
given color in the screen's color_map.
\since BeOS R3
*/
@ -250,6 +280,8 @@
\brief Gets the color_map of the BScreen.
\return A pointer to the BScreen object's color_map.
\since BeOS R3
*/
@ -257,7 +289,7 @@
/*!
\name Bitmap Methods
\name Bitmap
*/
@ -266,39 +298,43 @@
/*!
\fn status_t BScreen::GetBitmap(BBitmap** _bitmap, bool drawCursor,
BRect* bounds)
BRect* bounds)
\brief Allocates a BBitmap and copies the contents of the screen into it.
\note GetBitmap() will allocate a BBitmap object for you while
ReadBitmap() requires you to pre-allocate a BBitmap object first.
ReadBitmap() requires you to pre-allocate a BBitmap object first.
\note The caller is responsible for freeing the BBitmap object.
\param _bitmap A pointer to a BBitmap pointer where this method will
store the contents of the display.
store the contents of the display.
\param drawCursor Specifies whether or not to draw the cursor.
\param bounds Specifies the screen area that you want copied. If
\a bounds is \c NULL then the entire screen is copied.
\a bounds is \c NULL then the entire screen is copied.
\return \c B_OK if the operation was successful, \c B_ERROR otherwise.
\since BeOS R4
*/
/*!
\fn status_t BScreen::ReadBitmap(BBitmap* bitmap, bool drawCursor,
BRect* bounds)
BRect* bounds)
\brief Copies the contents of the screen into a BBitmap.
\note ReadBitmap() requires you to pre-allocate a BBitmap object first,
while GetBitmap() will allocate a BBitmap object for you.
while GetBitmap() will allocate a BBitmap object for you.
\param bitmap A pointer to a pre-allocated BBitmap where this
method will store the contents of the display.
method will store the contents of the display.
\param drawCursor Specifies whether or not to draw the cursor.
\param bounds Specifies the screen area that you want copied. If
\a bounds is \c NULL then the entire screen is copied.
\a bounds is \c NULL then the entire screen is copied.
\return \c B_OK if the operation was successful, \c B_ERROR otherwise.
\since BeOS R4
*/
@ -306,7 +342,7 @@
/*!
\name Desktop Color Methods
\name Desktop Color
*/
@ -319,6 +355,8 @@
\return A 32-bit rgb_color structure containing the background color
of the current workspace.
\since BeOS R3
*/
@ -331,6 +369,8 @@
\return An 32-bit rgb_color structure containing the background color
of the specified \a workspace.
\since Haiku R1
*/
@ -340,17 +380,21 @@
\param color The 32-bit \a color to paint the desktop background.
\param stick Whether or not the \a color will stay after a reboot.
\since BeOS R3
*/
/*!
\fn void BScreen::SetDesktopColor(rgb_color color, uint32 workspace,
bool stick)
bool stick)
\brief Set the background \a color of the specified \a workspace.
\param color The 32-bit \a color to paint the desktop background.
\param workspace The \a workspace index to update.
\param stick Whether or not the \a color will stay after a reboot.
\since Haiku R1
*/
@ -358,7 +402,7 @@
/*!
\name Display Mode Methods
\name Display Mode
The following methods retrieve and alter the display_mode structure
of a screen. The display_mode structure contains screen size,
@ -371,8 +415,7 @@
/*!
\fn status_t BScreen::ProposeMode(display_mode* target,
const display_mode* low,
const display_mode* high)
const display_mode* low, const display_mode* high)
\brief Adjust the \a target mode to make it a supported mode.
The list of supported modes for the graphics card is supplied by
@ -382,11 +425,14 @@
\param low The lower display mode limit.
\param high The higher display mode limit.
\returns A status code.
\retval B_OK if \a target is supported and falls within the
\a low and \a high limits.
\a low and \a high limits.
\retval B_BAD_VALUE if \a target is supported but does not
fall within the \a low and \a high limits.
fall within the \a low and \a high limits.
\retval B_ERROR if the target mode isn't supported.
\since BeOS R5
*/
@ -396,18 +442,20 @@
graphics card into \a _modeList.
\warning The monitor may not be able to display all of the modes that
GetModeList() retrieves.
GetModeList() retrieves.
\note The caller is responsible for freeing the display_mode object.
\param _modeList A pointer to a display_mode pointer, where the function
will allocate an array of display_mode structures.
will allocate an array of display_mode structures.
\param _count A pointer to an integer used to store the count of
available display modes.
available display modes.
\retval B_OK if the operation was successful.
\retval B_ERROR if \a modeList or \a count is invalid.
\retval B_ERROR for all other errors.
\since BeOS R5
*/
@ -420,13 +468,15 @@
\retval B_OK if the operation was successful.
\retval B_BAD_VALUE if \a mode is invalid.
\retval B_ERROR for all other errors.
\since BeOS R5
*/
/*!
\fn status_t BScreen::GetMode(uint32 workspace, display_mode* mode)
\brief Fills out the display_mode struct from the specified
\a workspace.
\a workspace.
\param workspace The index of the \a workspace to query.
\param mode A pointer to a display_mode structure to copy into.
@ -434,6 +484,8 @@
\retval B_OK if the operation was successful
\retval B_BAD_VALUE if \a mode is invalid.
\retval B_ERROR for all other errors.
\since Haiku R1
*/
@ -445,20 +497,24 @@
\param makeDefault Whether or not \a mode is set as the default.
\return \c B_OK if the operation was successful, \c B_ERROR otherwise.
\since BeOS R5
*/
/*!
\fn status_t BScreen::SetMode(uint32 workspace, display_mode* mode,
bool makeDefault)
bool makeDefault)
\brief Set the screen in the specified \a workspace to the given \a mode.
\param workspace The index of the workspace to set the \a mode of.
\param mode A pointer to a display_mode struct.
\param makeDefault Whether or not the \a mode is set as the default
for the specified \a workspace.
for the specified \a workspace.
\return \c B_OK if the operation was successful, \c B_ERROR otherwise.
\since Haiku R1
*/
@ -466,7 +522,7 @@
/*!
\name Display and Graphics Card Info Methods
\name Display and Graphics Card Info
*/
@ -478,11 +534,13 @@
\brief Fills out the \a info struct with information about a graphics card.
\param info An accelerant_device_info struct to store the device
\a info.
\a info.
\retval B_OK if the operation was successful.
\retval B_BAD_VALUE if \a info is invalid.
\retval B_ERROR for all other errors.
\since BeOS R5
*/
@ -495,12 +553,14 @@
\retval B_OK if the operation was successful.
\retval B_BAD_VALUE if \a info is invalid.
\retval B_ERROR for all other errors.
\since Haiku R1
*/
/*!
\fn status_t BScreen::GetPixelClockLimits(display_mode* mode,
uint32* _low, uint32* _high)
uint32* _low, uint32* _high)
\brief Gets the minimum and maximum pixel clock rates that are possible
for the specified \a mode.
@ -513,21 +573,25 @@
\retval B_OK if the operation was successful.
\retval B_BAD_VALUE if \a mode, \a low, or \a high is invalid.
\retval B_ERROR for all other errors.
\since BeOS R5
*/
/*!
\fn status_t BScreen::GetTimingConstraints(display_timing_constraints*
constraints)
\fn status_t BScreen::GetTimingConstraints(
display_timing_constraints* constraints)
\brief Fills out the \a constraints structure with the timing constraints
of the current display mode.
of the current display mode.
\param constraints A pointer to a display_timing_constraints structure
to store the timing constraints.
to store the timing constraints.
\retval B_OK if the operation was successful.
\retval B_BAD_VALUE if \a constraints is invalid.
\retval B_ERROR for all other errors.
\since BeOS R5
*/
@ -563,26 +627,29 @@
/*!
\fn status_t BScreen::SetDPMS(uint32 dpmsState)
\brief Sets the VESA Display Power Management Signaling (DPMS) state for
the display.
the display.
\param dpmsState The DPMS state to set.
valid values are:
- \c B_DPMS_ON
- \c B_DPMS_STAND_BY
- \c B_DPMS_SUSPEND
- \c B_DPMS_OFF
\param dpmsState The DPMS state to set, valid values are:
- \c B_DPMS_ON
- \c B_DPMS_STAND_BY
- \c B_DPMS_SUSPEND
- \c B_DPMS_OFF
\return \c B_OK if the operation was successful, otherwise an error code.
\since BeOS R5
*/
/*!
\fn uint32 BScreen::DPMSState()
\brief Gets the current VESA Display Power Management Signaling (DPMS)
state of the screen.
state of the screen.
\return The current VESA Display Power Management Signaling (DPMS) state
of the display or 0 in the case of an error.
of the display or 0 in the case of an error.
\since BeOS R5
*/
@ -590,7 +657,7 @@
/*!
\fn uint32 BScreen::DPMSCapabilites()
\brief Gets the VESA Display Power Management Signaling (DPMS)
modes that the display supports as a bit mask.
modes that the display supports as a bit mask.
- \c B_DPMS_ON is worth 1
- \c B_DPMS_STAND_BY is worth 2
@ -598,7 +665,9 @@
- \c B_DPMS_OFF is worth 8
\return A bit mask of the VESA Display Power Management Signaling (DPMS)
modes that the display supports or 0 in the case of an error.
modes that the display supports or 0 in the case of an error.
\since BeOS R5
*/
@ -606,7 +675,7 @@
/*!
\name Deprecated methods
\name Deprecated Methods
*/
@ -617,28 +686,35 @@
\fn BPrivate::BPrivateScreen* BScreen::private_screen()
\brief Returns the BPrivateScreen used by the BScreen object.
\return A pointer to the BPrivateScreen class internally used by the BScreen
object.
\return A pointer to the BPrivateScreen class internally used by the
BScreen object.
\since Haiku R1
*/
/*!
\fn status_t BScreen::ProposeDisplayMode(display_mode* target,
const display_mode* low,
const display_mode* high)
const display_mode* low, const display_mode* high)
\brief Deprecated, use ProposeMode() instead.
\since BeOS R5
*/
/*!
\fn void* BScreen::BaseAddress()
\brief Returns the base address of the frame buffer.
\since Haiku R1
*/
/*!
\fn uint32 BScreen::BytesPerRow()
\brief Returns the bytes per row of the frame buffer.
\since Haiku R1
*/

580
docs/user/interface/ScrollBar.dox Normal file
View File

@ -0,0 +1,580 @@
/*
* Copyright 2014 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* John Scipione, jscipione@gmail.com
*
* Corresponds to:
* headers/os/interface/ScrollBar.h hrev47312
* src/kits/interface/ScrollBar.cpp hrev47312
*/
/*!
\file ScrollBar.h
\ingroup interface
\ingroup libbe
\brief BScrollBar class definition.
\since BeOS R3
*/
/*!
\class BScrollBar
\ingroup interface
\ingroup libbe
\brief User interface element used to scroll a target view vertically or
horizontally.
Scroll bars are usually added as siblings of the target view, that way
when the parent is resized the target view and scroll bars can be resized
as well. The BScrollView class conveniently provides such a container view
adding the scroll bars and target view making itself the parent.
Scroll bars control the target view, but a target can also be scrolled
independently by calling BView::ScrollTo() or BView::ScrollBy().
When a target view is set to a BScrollBar, the view is notified and stores
a pointer to the BScrollBar object so that it can communicate its scroll
information back to the scroll bar.
\sa BView::ScrollTo()
\sa BView::ScrollBy()
\sa BView::ScrollBar()
\since BeOS R3
*/
/*!
\fn BScrollBar::BScrollBar(BRect frame, const char* name, BView* target,
float min, float max, orientation direction)
\brief Instantiates a new scroll bar and connects it to the \a target
view.
The \a frame rectangle defines the location and size of the scroll bar
within its parent view. A horizontal scroll bar should be
\c B_H_SCROLL_BAR_HEIGHT pixels high, and a vertical scroll bar should be
\c B_V_SCROLL_BAR_WIDTH pixels wide.
Unlike most BView derived constructors in the Interface Kit this method
doesn't provide a resizing mode. Scroll bars are assigned a resizing
behavior based on their \a direction. Horizontal scroll bars resize
themselves horizontally (\c B_FOLLOW_LEFT_RIGHT | \c B_FOLLOW_BOTTOM) and
vertical scroll bars resize themselves vertically
(\c B_FOLLOW_TOP_BOTTOM | \c B_FOLLOW_RIGHT).
\param frame The \a frame rectangle of the scroll bar.
\param name The name of the scroll bar, can be \c NULL.
\param target The \a target view to scroll, can be \c NULL.
\param min The \a min scroll value.
\param max The \a max scroll value.
\param direction The scroll \a direction. Either \c B_HORIZONTAL
or \c B_VERTICAL.
\sa SetTarget() to set the \a target.
\sa SetRange() to set the \a min and \a max values.
\sa SetOrientation() to set the scroll bar \a direction.
\since BeOS R3
*/
/*!
\fn BScrollBar::BScrollBar(const char* name, BView* target,
float min, float max, orientation direction)
\brief Instantiates a new scroll bar to be used as part of a layout and
connects it to the \a target view.
\param name The name of the scroll bar, can be \c NULL.
\param target The \a target view to scroll, can be \c NULL.
\param min The \a min scroll value.
\param max The \a max scroll value.
\param direction The scroll \a direction. Either \c B_HORIZONTAL
or \c B_VERTICAL.
\sa SetTarget() to set the \a target.
\sa SetRange() to set the \a min and \a max values.
\sa SetOrientation() to set the scroll bar \a direction.
\since Haiku R1
*/
/*!
\fn BScrollBar::BScrollBar(BMessage* data)
\brief Archive constructor.
\param data The message \a data to construct the scroll bar from.
\since BeOS R3
*/
/*!
\fn BScrollBar::~BScrollBar()
\brief Destructor method.
Deletes the scroll bar, sets the target to \c NULL and frees any
memory used.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BScrollBar::Instantiate(BMessage* data)
\brief Creates a new BScrollBar object from the \a data message.
\return A newly created scroll bar or \c NULL if the message doesn't
contain an archived BScrollBar object.
\since BeOS R3
*/
/*!
\fn status_t BScrollBar::Archive(BMessage* data, bool deep) const
\brief Archives the object into the \a data message.
\param data A pointer to the BMessage object to archive the object into.
\param deep Whether or not to archive child views as well.
\return A status code, \c B_OK if everything went well or an error code
otherwise.
\since BeOS R3
*/
//! @}
/*!
\fn void BScrollBar::SetValue(float value)
\brief Sets the value of the scroll bar scrolling the scroll thumb and
target view accordingly.
Setting the \a value programmatically using this method causes the
ValueChanged() method to be called.
Derived classes can override this method to do something different than
scrolling the target view.
\param value The value to set the scroll bar value to, rounded to the
nearest integer.
\sa ValueChanged()
\since BeOS R3
*/
/*!
\fn float BScrollBar::Value() const
\brief Returns the scroll bar's value.
\return The scroll bar's value as a float.
\since BeOS R3
*/
/*!
\fn void BScrollBar::SetProportion(float value)
\brief Set the ratio of the size of a scroll knob to the scroll bar.
\note If \a value is outside the range 0.0 to 1.0 it is clipped
to that range.
\param value a number between 0.0 and 1.0 that represents the proportion of
the document that can be displayed within the target view.
\since BeOS R3
*/
/*!
\fn float BScrollBar::Proportion() const
\brief Returns the ratio of the size of a scroll knob to the scroll bar.
\return A value between 0.0 and 1.0 as a float.
\since BeOS R3
*/
/*!
\fn void BScrollBar::SetRange(float min, float max)
\brief Set the range of values that the scroll bar represents from \a min to
\a max.
These values should be calculated from the enclosing bounds of the target view.
If \a min and \a max are both 0 the scroll bar is disabled and the knob is not
drawn.
If the range changes such that the value is clipped SetValue() is called which
triggers ValueChanged() to be triggered.
\param min The \a min value of the range, rounded to the nearest integer.
\param max The \a max value of the range, rounded to the nearest integer.
\since BeOS R3
*/
/*!
\fn void BScrollBar::GetRange(float* min, float* max) const
\brief Fills out \a min and \a max with the minimum and maximum range values.
\remark Either \a min or \a max may be set to \c NULL if you only want to get
the other one.
\param min A pointer to a float to be filled out with the \a min value.
\param max A pointer to a float to be filled out with the \a max value.
\since BeOS R3
*/
/*!
\fn void BScrollBar::SetSteps(float smallStep, float largeStep)
\brief Sets how far the scroll bar moves when it is scrolled.
\note In BeOS R5, steps can be set only after the scroll bar is attached
to a window, probably because the data is kept server-side, in Haiku
this limitation has been removed.
\note The BeBook also says that we need to specify an integral value even
though the step values are floats, in Haiku we round the values
instead.
\param smallStep The value to move the scroll bar under normal conditions.
\param largeStep The value to move the scroll bar taking a large step,
this is usually triggered by holding down the \key{Shift} key while
scrolling.
\since BeOS R3
*/
/*!
\fn void BScrollBar::GetSteps(float* smallStep, float* largeStep) const
\brief Fills out \a smallStop and \a largeStep with the small and large
step values respectively.
\remark Either \a smallStep or \a largeStep may be set to \c NULL if you
only want to get the other one.
\param smallStep A pointer to a float to be filled out with the small step
value.
\param largeStep A pointer to a float to be filled out with the large step
value.
\since BeOS R3
*/
/*!
\fn void BScrollBar::SetTarget(BView* target)
\brief Sets the \a target view that the scroll bar operates on unsetting
the previous target.
\param target The \a target view to set.
\since BeOS R3
*/
/*!
\fn void BScrollBar::SetTarget(const char* targetName)
\brief Sets the target view to the view identified by \a targetName
unsetting the previous target.
\note The BeOS R5 implementation crashes for \a targetName == \c NULL
and also does not modify the target if it can't be found.
\param targetName The name of the view to target.
\since BeOS R3
*/
/*!
\fn BView* BScrollBar::Target() const
\brief Returns a pointer to the target view.
\return A pointer to a BView object that represents the target view or
\c NULL if the target is not set.
\since BeOS R3
*/
/*!
\fn void BScrollBar::SetOrientation(orientation direction)
\brief Sets the \a direction of the scroll view.
\param direction Either \a B_HORIZONTAL or \a B_VERTICAL.
\since Haiku R1
*/
/*!
\fn orientation BScrollBar::Orientation() const
\brief Returns the direction of the scroll bar.
\return Either \a B_HORIZONTAL or \a B_VERTICAL.
\since Haiku R1
*/
/*!
\fn status_t BScrollBar::SetBorderHighlighted(bool highlight)
\brief Highlights or unhighlights the border of the scroll bar.
\param highlight \c true to turn highlighting on, \c false to remove it.
\return If successful returns \c B_OK, otherwise, returns \c B_ERROR.
\since Haiku R1
*/
/*!
\name Hook Methods
*/
//! @{
/*!
\fn void BScrollBar::AllAttached()
\copydoc BView::AllAttached()
*/
/*!
\fn void BScrollBar::AllDetached()
\copydoc BView::AllDetached()
*/
/*!
\fn void BScrollBar::AttachedToWindow()
\brief Hook method called when the scroll bar is attached to a window.
This method does nothing, unlike in BeOS R5. In BeOS scroll bars were
implemented directly in the App Server, the client BScrollBar was just a
proxy which needed to be synced up on AttachedToWindow(). On Haiku, scroll
bars are implemented more sanely and thus don't need to do this.
\copydetails BView::AttachedToWindow()
*/
/*!
\fn void BScrollBar::DetachedFromWindow()
\copydoc BView::DetachedFromWindow()
*/
/*!
\fn void BScrollBar::Draw(BRect updateRect)
\brief Draws the area of the scroll bar that intersects \a updateRect.
\param updateRect The rectangular area to be drawn.
\since BeOS R3
*/
/*!
\fn void BScrollBar::FrameMoved(BPoint newPosition)
\brief Hook method called when the scroll bar is moved.
\copydetails BView::FrameMoved()
*/
/*!
\fn void BScrollBar::FrameResized(float newWidth, float newHeight)
\brief Hook method called when the scroll bar is resized.
\copydetails BView::FrameResized()
*/
/*!
\fn void BScrollBar::MessageReceived(BMessage* message)
\brief Handle \a message received by the associated looper.
Calls ValueChanged() in response to \c B_VALUE_CHANGED.
Scrolls the view in response to \c B_MOUSE_WHEEL_CHANGED.
\copydetails BView::MessageReceived()
*/
/*!
\fn void BScrollBar::MouseDown(BPoint where)
\brief Hook method called when a mouse button is pressed.
Begins scrolling the target view in response to a mouse click. If the
user clicked the scroll bar thumb this begins scrolling and continues
in MouseMoved() ending on MouseUp(). If the user clicked on one of the
scroll arrows the view is scrolled a small amount, if the user clicks
on an area of the scroll view outside the arrows and thumb the view is
scrolled by a larger amount.
\copydetails BView::MouseDown()
*/
/*!
\fn void BScrollBar::MouseMoved(BPoint where, uint32 code,
const BMessage* dragMessage)
\brief Hook method called when the mouse is moved.
If the user clicked on the scroll bar thumb the view is scrolled as the user
moves the mouse up and down or left and right.
\copydetails BView::MouseMoved()
*/
/*!
\fn void BScrollBar::MouseUp(BPoint where)
\brief Hook method called when a mouse button is released.
Finishes scrolling and redraws the scroll bar if necessary.
\copydetails BView::MouseUp()
*/
/*!
\fn void BScrollBar::ValueChanged(float newValue)
\brief Hook method called when the value of the scroll bar changes.
\param newValue The new scroll bar value.
\since BeOS R3
*/
/*!
\fn void BScrollBar::WindowActivated(bool active)
\copydoc BView::WindowActivated()
*/
//! @}
/*!
\fn void BScrollBar::ResizeToPreferred()
\copydoc BView::ResizeToPreferred()
*/
/*!
\fn void BScrollBar::GetPreferredSize(float* _width, float* _height)
\brief Fill out the preferred width and height of the scroll bar
into the \a _width and \a _height parameters.
\copydetails BView::GetPreferredSize()
*/
/*!
\fn void BScrollBar::MakeFocus(bool focus)
\brief Makes the scroll bar the current focus view of the window or gives up
being the window's focus view.
\copydetails BView::MakeFocus()
*/
/*!
\fn BSize BScrollBar::MinSize()
\brief Return the scroll bar's minimum size.
\return The minimum size of the scroll bar as a BSize.
\sa BAbstractLayout::MinSize()
\since Haiku R1
*/
/*!
\fn BSize BScrollBar::MaxSize()
\brief Return the scroll bar's maximum size.
\return The maximum size of the scroll bar as a BSize.
\sa BAbstractLayout::MaxSize()
\since Haiku R1
*/
/*!
\fn BSize BScrollBar::PreferredSize()
\brief Return the scroll bar's preferred size.
\return The preferred size of the scroll bar as a BSize.
\sa BAbstractLayout::PreferredSize()
\since Haiku R1
*/
/*!
\fn status_t BScrollBar::Perform(perform_code code, void* _data)
\brief Perform some action. (Internal Method)
\since Haiku R1
*/
/*!
\name Scripting
*/
//! @{
/*!
\fn status_t BScrollBar::GetSupportedSuites(BMessage* message)
\brief Reports the suites of messages and specifiers understood by the
scroll bar.
\copydetails BView::GetSupportedSuites()
*/
/*!
\fn BHandler* BScrollBar::ResolveSpecifier(BMessage* message, int32 index,
BMessage* specifier, int32 what, const char* property)
\brief Determine the proper handler for a scripting message.
\copydetails BView::ResolveSpecifier()
*/
//! @}

457
docs/user/interface/ScrollView.dox Normal file
View File

@ -0,0 +1,457 @@
/*
* Copyright 2014 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* John Scipione, jscipione@gmail.com
*
* Corresponds to:
* headers/os/interface/ScrollView.h hrev47312
* src/kits/interface/ScrollView.cpp hrev47312
*/
/*!
\file ScrollView.h
\ingroup interface
\ingroup libbe
\brief BScrollView class definition.
\since BeOS R3
*/
/*!
\class BScrollView
\ingroup interface
\ingroup libbe
\brief A convenience class used to add scrolling to a target view.
The BScrollView class conveniently provides a container view
adding the scroll bars and target view as siblings so that when one
is moved or resized the rest can follow.
\see BScrollBar to learn more about how scroll bars work.
\sa BView::ScrollTo()
\sa BView::ScrollBy()
\sa BView::TargetedByScrollView()
\since BeOS R3
*/
/*!
\fn BScrollView::BScrollView(const char* name, BView* target,
uint32 resizingMode, uint32 flags, bool horizontal, bool vertical,
border_style border)
\brief Instantiates a new scroll view and connects it to the \a target
view.
\param name The name of the scroll bar, can be \c NULL.
\param target The \a target view to scroll, can be \c NULL.
\param resizingMode Defines the scroll view's behavior when its parent
is resized. See BView for details.
\param flags The view flags. See BView for details.
\param horizontal Whether or not to include a horizontal scroll bar.
\param vertical Whether or not to include a vertical scroll bar.
\param border The border style to use, options include:
- \c B_PLAIN_BORDER
- \c B_FANCY_BORDER
- \c B_NO_BORDER
\sa SetTarget()
\sa SetBorder()
\since BeOS R3
*/
/*!
\fn BScrollView::BScrollView(const char* name, BView* target, uint32 flags,
bool horizontal, bool vertical, border_style border)
\brief Instantiates a new scroll view and connects it to the \a target
view suitable for use in a BLayout.
\param name The name of the scroll bar, can be \c NULL.
\param target The \a target view to scroll, can be \c NULL.
\param flags The view flags. See BView for details.
\param horizontal Whether or not to include a horizontal scroll bar.
\param vertical Whether or not to include a vertical scroll bar.
\param border The border style to use, options include:
- \c B_PLAIN_BORDER
- \c B_FANCY_BORDER
- \c B_NO_BORDER
\sa SetTarget()
\sa SetBorder()
\since Haiku R1
*/
/*!
\fn BScrollView::BScrollView(BMessage* archive)
\brief Archive constructor.
\param archive The message \a data to construct the scroll view from.
\since BeOS R3
*/
/*!
\fn BScrollView::~BScrollView()
\brief Destructor method.
Deletes the scroll view, sets the target to \c NULL and frees any
memory used.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BScrollView::Instantiate(BMessage* archive)
\brief Creates a new BScrollView object from the \a archive message.
\return A newly created scroll view or \c NULL if the message doesn't
contain an archived BScrollView object.
\since BeOS R3
*/
/*!
\fn status_t BScrollView::Archive(BMessage* archive, bool deep) const
\brief Archives the object into the \a archive message.
\param archive A pointer to the BMessage object to archive the object into.
\param deep Whether or not to archive child views as well.
\return A status code, \c B_OK if everything went well or an error code
otherwise.
\since BeOS R3
*/
//! @}
/*!
\name Hook Methods
*/
//! @{
/*!
\fn void BScrollView::AllAttached()
\copydoc BView::AllAttached()
*/
/*!
\fn void BScrollView::AllDetached()
\copydoc BView::AllDetached()
*/
/*!
\fn void BScrollView::AttachedToWindow()
\brief Hook method called when the scroll bar is attached to a window.
Checks if the window uses \c B_DOCUMENT_LOOK and adjust the size of the bars
to make room for the window resize knob.
\copydetails BView::AttachedToWindow()
*/
/*!
\fn void BScrollView::DetachedFromWindow()
\brief Hook method called when the object is detached from a window.
\copydetails BView::DetachedFromWindow()
*/
/*!
\fn void BScrollView::Draw(BRect updateRect)
\brief Draws the area of the scroll view that intersects \a updateRect.
\param updateRect The rectangular area to be drawn.
\since BeOS R3
*/
/*!
\fn void BScrollView::MakeFocus(bool focus)
\brief Makes the scroll view the current focus view of the window or gives
up being the window's focus view.
\copydetails BView::MakeFocus()
*/
/*!
\fn void BScrollView::FrameMoved(BPoint newPosition)
\brief Hook method called when the scroll view is moved.
\copydetails BView::FrameMoved()
*/
/*!
\fn void BScrollView::FrameResized(float newWidth, float newHeight)
\brief Hook method called when the scroll view is resized.
\copydetails BView::FrameResized()
*/
/*!
\fn void BScrollView::MessageReceived(BMessage* message)
\copydoc BView::MessageReceived()
*/
/*!
\fn void BScrollView::MouseDown(BPoint where)
\copydoc BView::MouseDown()
*/
/*!
\fn void BScrollView::MouseMoved(BPoint where, uint32 code,
const BMessage* dragMessage)
\copydoc BView::MouseMoved()
*/
/*!
\fn void BScrollView::MouseUp(BPoint where)
\copydoc BView::MouseUp()
*/
/*!
\fn void BScrollView::WindowActivated(bool active)
\copydoc BView::WindowActivated()
*/
//! @}
/*!
\fn void BScrollView::GetPreferredSize(float* _width, float* _height)
\brief Fill out the preferred width and height of the scroll view
into the \a _width and \a _height parameters.
\copydetails BView::GetPreferredSize()
*/
/*!
\fn BSize BScrollView::MinSize()
\brief Return the scroll view's minimum size.
\return The minimum size of the scroll view as a BSize.
\sa BAbstractLayout::MinSize()
\since Haiku R1
*/
/*!
\fn BSize BScrollView::MaxSize()
\brief Return the scroll view's maximum size.
\return The maximum size of the scroll view as a BSize.
\sa BAbstractLayout::MaxSize()
\since Haiku R1
*/
/*!
\fn BSize BScrollView::PreferredSize()
\brief Return the scroll view's preferred size.
\return The preferred size of the scroll view as a BSize.
\sa BAbstractLayout::PreferredSize()
\since Haiku R1
*/
/*!
\fn void BScrollView::ResizeToPreferred()
\brief Resizes the scroll view to its preferred size keeping the position of
the left top corner constant.
\copydetails BView::ResizeToPreferred()
*/
/*!
\name BScrollBar
*/
//! @{
/*!
\fn BScrollBar* BScrollView::ScrollBar(orientation direction) const
\brief Returns the BScrollBar object at the given \a direction.
\param direction The \a direction of the scroll bar to get.
\returns A pointer to the desired BScrollBar object or \c NULL
if there is no scroll bar at that location.
\since BeOS R3
*/
/*!
\fn void BScrollView::SetBorder(border_style border)
\brief Set the border style of the scroll view.
\param border The border style constant to use, on of the following:
- \c B_PLAIN_BORDER
- \c B_FANCY_BORDER
- \c B_NO_BORDER
\since BeOS R3
*/
/*!
\fn border_style BScrollView::Border() const
\brief Return the border style used.
\return The border style constant used.
\since BeOS R3
*/
/*!
\fn status_t BScrollView::SetBorderHighlighted(bool highlight)
\brief Highlights or unhighlights the border of the scroll view's
scroll bars.
\param highlight \c true to turn highlighting on, \c false to remove it.
\return If successful returns \c B_OK, otherwise, returns \c B_ERROR.
\since BeOS R3
*/
/*!
\fn bool BScrollView::IsBorderHighlighted() const
\brief Returns whether or not the border is highlighted.
\return \c true if the border is highlighted, \c false otherwise.
\since BeOS R3
*/
/*!
\fn void BScrollView::SetTarget(BView* target)
\brief Sets the \a target view that the scroll bars operates on unsetting
the previous target.
\param target The \a target view to set.
\since Haiku R1
*/
/*!
\fn BView* BScrollView::Target() const
\brief Returns a pointer to the target view.
\return A pointer to a BView object that represents the target view or
\c NULL if the target is not set.
\since Haiku R1
*/
//! @}
/*!
\name Scripting
*/
//! @{
/*!
\fn BHandler* BScrollView::ResolveSpecifier(BMessage* message, int32 index,
BMessage* specifier, int32 what, const char* property)
\brief Determine the proper handler for a scripting message.
\copydetails BView::ResolveSpecifier()
*/
/*!
\fn status_t BScrollView::GetSupportedSuites(BMessage* message)
\brief Reports the suites of messages and specifiers understood by the
scroll view.
\copydetails BView::GetSupportedSuites()
*/
//! @}
/*!
\fn status_t BScrollView::Perform(perform_code code, void* _data)
\brief Perform some action. (Internal Method)
\since Haiku R1
*/
/*!
\fn void BScrollView::LayoutInvalidated(bool descendants)
\brief Hook method called when the layout is invalidated.
The default implementation does nothing.
\param descendants Whether or not child views have also been invalidated.
\since Haiku R1
*/
/*!
\fn void BScrollView::DoLayout()
\brief Layout view within the layout context.
\since Haiku R1
*/

31
docs/user/interface/SeparatorItem.dox
View File

@ -30,6 +30,8 @@
\warning BSeparatorItems are only meant to be used with menus whose
items are arranged in a \c B_ITEMS_IN_COLUMN layout.
\since BeOS R3
*/
@ -39,6 +41,8 @@
The creates a new BSeparatorItem from BMenuItem with a blank label and
\c NULL message, then disables it.
\since BeOS R3
*/
@ -47,15 +51,27 @@
\brief Archive constructor.
\param data The message \a data to construct the separator item from.
\since BeOS R3
*/
/*!
\fn BSeparatorItem::~BSeparatorItem()
\brief Destructor, does nothing.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn status_t BSeparatorItem::Archive(BMessage* data, bool deep) const
\brief Archives the the BSeparatorItem object into the \a data message.
@ -67,6 +83,8 @@
otherwise.
\retval B_OK The object was archived successfully.
\retval B_NO_MEMORY Ran out of memory while archiving the object.
\since BeOS R3
*/
@ -76,13 +94,22 @@
\return A newly created BSeparatorItem object or \c NULL if the message
doesn't contain an archived BSeparatorItem.
\since BeOS R3
*/
//! @}
/*!
\fn void BSeparatorItem::SetEnabled(bool enable)
\brief Does nothing, this method is defined to override the default
BMenuItem behavior.
\param enable Not used.
\since BeOS R3
*/
@ -100,6 +127,8 @@
\sa ContentLocation()
\sa DrawContent()
\since BeOS R3
*/
@ -112,4 +141,6 @@
to do something other than the default.
The default draws a light grey horizontal line through the middle of the item.
\since BeOS R3
*/

36
docs/user/interface/StringItem.dox
View File

@ -25,6 +25,8 @@
\ingroup libbe
\brief A list item of a text string used as a member of a BListView
or BOutlineListView.
\since BeOS R3
*/
@ -37,7 +39,10 @@
\param text The \a text to display.
\param level The \a level of the item in a BOutlineListView.
\param expanded Whether or not the item is \a expanded in a BOutlineListView.
\param expanded Whether or not the item is \a expanded in a
BOutlineListView.
\since BeOS R3
*/
@ -46,21 +51,35 @@
\brief Archive constructor.
\param archive The message \a archive to construct the string item from.
\since BeOS R3
*/
/*!
\fn BStringItem::~BStringItem()
\brief Destructor, frees the memory used by the string.
\since BeOS R3
*/
/*!
\name Archiving
*/
//! @{
/*!
\fn BArchivable* BStringItem::Instantiate(BMessage* archive)
\brief Creates a new BStringItem object from an \a archive message.
\return A newly created BStringItem object or \c NULL if the message
doesn't contain an archived BStringItem.
\since BeOS R3
*/
@ -75,9 +94,14 @@
otherwise.
\retval B_OK The object was archived successfully.
\retval B_NO_MEMORY Ran out of memory while archiving the object.
\since BeOS R3
*/
//! @}
/*!
\fn void BStringItem::DrawItem(BView* owner, BRect frame, bool complete)
\brief Hook method called when the string item is drawn.
@ -100,6 +124,8 @@
\sa IsSelected()
\sa IsEnabled()
\since BeOS R3
*/
@ -109,6 +135,8 @@
old string is freed.
\param text The \a text string to set in a C-string.
\since BeOS R3
*/
@ -117,6 +145,8 @@
\returns The text set to the item.
\returns the text set to the item as a C-string.
\since BeOS R3
*/
@ -131,6 +161,8 @@
\param owner The list item's new \a owner.
\param font The font set to the list item's current \a owner.
\since BeOS R3
*/
@ -145,4 +177,6 @@
This may be overridden by derived classes to set the base line offset.
\returns The offset to the baseline of the text as a float.
\since Haiku R1
*/

407
docs/user/interface/TextView.dox
View File

File diff suppressed because it is too large Load Diff

48
docs/user/interface/TwoDimensionalLayout.dox
View File

@ -35,22 +35,28 @@
\warning This class is not yet finalized, if you use it in your software
assume that it will break some time in the future.
\since Haiku R1
*/
/*!
\struct BTwoDimensionalLayout::ColumnRowConstraints
\brief Used by BTwoDimensionalLayout derived classes to communicate the
size constraints for a given column or row to the
BTwoDimensionalLayout class.
size constraints for a given column or row to the
BTwoDimensionalLayout class.
\since Haiku R1
*/
/*!
\struct BTwoDimensionalLayout::Dimensions
\brief Used by BTwoDimensionalLayout derived classes to communicate the
positioning and size of a BLayoutItem, in terms of columns and rows to
the BTwoDimensionalLayout class.
positioning and size of a BLayoutItem, in terms of columns and rows
to the BTwoDimensionalLayout class.
\since Haiku R1
*/
@ -58,7 +64,7 @@
\fn void BTwoDimensionalLayout::AlignLayoutWith(
BTwoDimensionalLayout* other, orientation orientation)
\brief Align the BLayoutItem&apos;s in the specified \a orientation within
two or more BTwoDimensionalLayout&apos;s.
two or more BTwoDimensionalLayout&apos;s.
When two (or more) BTwoDimensionalLayout&apos;s are aligned within a
certain \a orientation, then the BLayoutItem&apos;s within those
@ -73,6 +79,8 @@
\param other The BTwoDimensionalLayout to be aligned with.
\param orientation The \a orientation on which to be aligned.
\since Haiku R1
*/
@ -86,6 +94,8 @@
be replaced with the value returned by BControlLook::DefaultItemSpacing().
\see BTwoDimensionalLayout::GetInsets();
\since Haiku R1
*/
@ -98,11 +108,13 @@
be ignored.
\see BTwoDimensionalLayout::SetInsets();
\since Haiku R1
*/
/*!
\name BTwoDimensionalLayout Hook methods
\name Hook Methods
These methods are called automatically as needed during layout, and
provide the BTwoDimensionalLayout class with the necessary information
@ -116,28 +128,34 @@
/*!
\fn void BTwoDimensionalLayout::PrepareItems(orientation orientation)
\brief Prepare the BLayoutItem in this BTwoDimensionalLayout subclass
for layout within a certain \a orientation.
for layout within a certain \a orientation.
This is a good place to update cache information that will be used in
other hook methods, for example.
\since Haiku R1
*/
/*!
\fn bool BTwoDimensionalLayout::HasMultiColumnItems()
\brief Tests whether or not this BTwoDimensionalLayout contains any
BLayoutItem&apos;s spanning more than one column.
BLayoutItem&apos;s spanning more than one column.
The BTwoDimensionalLayout implementation returns false.
\since Haiku R1
*/
/*!
\fn bool BTwoDimensionalLayout::HasMultiRowItems()
\brief Tests whether or not this BTwoDimensionalLayout contains any
BLayoutItem&apos;s spanning more than one row.
BLayoutItem&apos;s spanning more than one row.
The BTwoDimensionalLayout implementation returns false.
\since Haiku R1
*/
@ -146,6 +164,8 @@
\brief Get the number of columns in the BTwoDimensionalLayout.
\returns The number of columns in the BTwoDimensionalLayout.
\since Haiku R1
*/
@ -154,6 +174,8 @@
\brief Get the number of rows in the BTwoDimensionalLayout.
\returns The number of rows in the BTwoDimensionalLayout.
\since Haiku R1
*/
@ -161,10 +183,12 @@
\fn void BTwoDimensionalLayout::GetColumnRowConstraints(
orientation orientation, int32 index, ColumnRowConstraints* constraints)
\brief Fill in the ColumnRowConstraints for a certain column or row in
the BTwoDimensionalLayout.
the BTwoDimensionalLayout.
This method is used to communicate the size constraints and weight for
a given row/column in the BTwoDimensionalLayout.
\since Haiku R1
*/
@ -172,7 +196,9 @@
\fn void BTwoDimensionalLayout::GetItemDimensions(BLayoutItem* item,
Dimensions* dimensions)
\brief Tell the base class what column and row a BLayoutItem is in as
well as how many columns and rows it covers.
well as how many columns and rows it covers.
\since Haiku R1
*/

867
docs/user/interface/View.dox
View File

File diff suppressed because it is too large Load Diff

386
docs/user/interface/Window.dox
View File

File diff suppressed because it is too large Load Diff