BColorControl displays an on-screen color picker. More...

Inheritance diagram for BColorControl:

Public Member Functions
	BColorControl (BPoint start, color_control_layout layout, float cellSize, const char name, BMessage message=NULL, bool useOffscreen=false)
	Constructs a new color control object.
	BColorControl (BMessage *archive)
	Constructs a BColorControl object from an archive message.
virtual	~BColorControl ()
	Destructor method.
virtual status_t	AllArchived (BMessage *archive) const
	Method relating to the use of `BArchiver`.
virtual void	AllAttached ()
	Similar to AttachedToWindow() but this method is triggered after all child views have already been attached to a window.
virtual void	AllDetached ()
	Similar to AttachedToWindow() but this method is triggered after all child views have already been detached from a window.
virtual status_t	AllUnarchived (const BMessage *archive)
	Method relating to the use of `BUnarchiver`.
virtual status_t	Archive (BMessage *archive, bool deep=true) const
	Archives the object into archive.
virtual void	AttachedToWindow ()
	Hook method that is called when the object is attached to a window.
float	CellSize () const
	Get the current color cell size.
virtual void	DetachedFromWindow ()
	Hook method that is called when the object is detached from a window.
virtual void	Draw (BRect updateRect)
	Draws the area of the color control that intersects updateRect.
virtual void	DrawAfterChildren (BRect r)
	Perform any drawing that needs to be done after child view have already been drawn.
virtual void	FrameMoved (BPoint newPosition)
	Hook method that gets called when the color control is moved.
virtual void	FrameResized (float newWidth, float newHeight)
	Hook method that gets called when the checkbox is resized.
BLayout *	GetLayout () const
	Get the layout of the view.
virtual void	GetPreferredSize (float _width, float _height)
	Fill out the preferred width and height of the checkbox into the _width and _height parameters.
virtual status_t	GetSupportedSuites (BMessage *data)
	Report the suites of understood messages.
virtual status_t	Invoke (BMessage *message=NULL)
	Tells the messenger to send a message.
bool	IsEnabled () const
	Gets whether or not the control is currently enabled.
virtual void	KeyDown (const char *bytes, int32 numBytes)
	Hook method that is called when a keyboard key is pressed.
virtual void	KeyUp (const char *bytes, int32 numBytes)
	Hook method that is called when a keyboard key is released.
const char *	Label () const
	Gets the label of the control.
color_control_layout	Layout () const
	Get the current color control layout.
virtual void	MakeFocus (bool state=true)
	Gives focus to or removes focus from the color control.
virtual BSize	MaxSize ()
	Get the maximum size of the view.
virtual void	MessageReceived (BMessage *message)
	Handle message that has been received by the associated looper.
virtual BSize	MinSize ()
	Get the minimum size of the view.
virtual void	MouseDown (BPoint where)
	Hook method that is called when a mouse button is pressed.
virtual void	MouseMoved (BPoint point, uint32 code, const BMessage *dragMessage)
	Hook method that is called when the mouse is moved.
virtual void	MouseUp (BPoint point)
	Hook method that is called when a mouse button is released.
virtual BSize	PreferredSize ()
	Get the preferred size of the view.
virtual void	Pulse ()
	Hook method that gets invoked when the view receives a `B_PULSE` message.
virtual void	ResizeToPreferred ()
	Resize the color control to its preferred size.
virtual BHandler *	ResolveSpecifier (BMessage message, int32 index, BMessage specifier, int32 what, const char *property)
	Determine the proper specifier for scripting messages.
virtual void	SetCellSize (float size)
	Set the size of the color cell in the color control.
virtual void	SetEnabled (bool state)
	Enable and disable the color control.
void	SetExplicitAlignment (BAlignment alignment)
	Set this item's explicit alignment, to be used by Alignment().
void	SetExplicitMaxSize (BSize size)
	Set this item's explicit max size, to be used by MaxSize().
void	SetExplicitMinSize (BSize size)
	Set this item's explicit min size, to be used by MinSize().
void	SetExplicitPreferredSize (BSize size)
	Set this item's explicit preferred size, to be used by PreferredSize().
virtual void	SetLabel (const char *string)
	Sets the label of the control.
virtual void	SetLayout (BLayout *layout)
	Set the layout of the BColorControl object to layout.
virtual void	SetLayout (color_control_layout layout)
	Set the layout of the color control.
virtual void	SetValue (int32 color_value)
	Set the color of the BColorControl to value.
void	SetValue (rgb_color color)
	Set the color of the BColorControl to color.
int32	Value () const
	Gets the value of the control.
rgb_color	ValueAsColor ()
	Return the current color value as an rgb_color.
virtual void	WindowActivated (bool state)
	Hook method that is called when the attached window becomes activated or deactivated.
Methods triggering or related to laying out this BLayout.
BLayoutContext *	LayoutContext () const
	Returns the BLayoutContext this BLayout is currently operating in, or `NULL`.
Core Handler Functionality
BLooper *	Looper () const
	Return a pointer to the looper that this handler is associated with.
void	SetName (const char *name)
	Set or change the name of this handler.
const char *	Name () const
	Return the name of this handler.
virtual void	SetNextHandler (BHandler *handler)
	Set the next handler in the chain that the message is passed on to if this handler cannot process it.
BHandler *	NextHandler () const
	Return the next hander in the chain to which the message is passed on.
Message Filtering
virtual void	AddFilter (BMessageFilter *filter)
	Add filter as a prerequisite to this handler.
virtual bool	RemoveFilter (BMessageFilter *filter)
	Remove filter from the filter list.
virtual void	SetFilterList (BList *filters)
	Set the internal list of filters to filters.
BList *	FilterList ()
	Return a pointer to the list of filters.
Locking
This class provides some utility functions to look the looper associated with this handler.
bool	LockLooper ()
	Lock the looper associated with this handler.
status_t	LockLooperWithTimeout (bigtime_t timeout)
	Lock the looper associated with this handler, with a time out value.
void	UnlockLooper ()
	Unlock the looper.
Observing
Handlers can function as state machines, which emit messages to observers when the state changes. Use the following methods to subscribe to these notifications. Note that there is a semantic difference between the two StartWatching() methods. The overloaded method that accepts a BHandler, expects as argument an observer that watches this handler. The method that accepts a BMessenger, expects a target that emits the state changes to this handler.
status_t	StartWatching (BMessenger target, uint32 what)
	Subscribe this handler to watch a specific state change of a target.
status_t	StartWatching (BHandler *observer, uint32 what)
	Subscribe an observer for a specific state change of this handler.
status_t	StartWatchingAll (BMessenger target)
	Subscribe this handler to watch a target for all events.
status_t	StartWatchingAll (BHandler *observer)
	Subscribe an observer for a all state changes.
status_t	StopWatching (BMessenger target, uint32 what)
	Unsubscribe this handler from watching a specific state.
status_t	StopWatching (BHandler *observer, uint32 what)
	Unsubscribe an observer from watching a specific state.
status_t	StopWatchingAll (BMessenger target)
	Unsubscribe this handler from watching all states.
status_t	StopWatchingAll (BHandler *observer)
	Unsubscribe an observer from watching all states.
Emitting State Changes
If your handler functions as a state machine, and it has observers (which subscribed using the StartWatching() method), you can emit these state changes.
virtual void	SendNotices (uint32 what, const BMessage *notice=NULL)
	Emit a state change to the observers.
bool	IsWatched () const
	Check if there are any observers watching this handler.
Static Public Member Functions
static BArchivable *	Instantiate (BMessage *archive)
	Creates a new object from an archive.
Protected Member Functions
void	SetValueNoUpdate (int32 value)
	Sets the value of the control without redrawing.
BLayout Hook methods
virtual void	LayoutInvalidated (bool descendants=false)

Detailed Description

BColorControl displays an on-screen color picker.

The value of the color control is a rgb_color data structure containing a 32-bit color. If a message is specified in the constructor then the message is sent to a target in response to changes in the color value.

The color value is initially set to 0 which corresponds to black. To set the color of the color control use the SetValue() method.

An example of creating a color control looks like this:

colorControl = new BColorControl(BPoint(0, 0), B_CELLS_32x8, 7.0,
    "ColorControl", new BMessage(kValueChanged));
colorControl->SetValue(0x336698);

A BColorControl contains four color ramps to set the red, green, and blue components of the color control value. A greyscale slider is provided to easily select black, white, and shades of grey. The color control also contains three child BTextControl objects used to set the color by typing in a number between 0 and 255 for the red, green, and blue components of the color value.

If the screen is set to 8-bit (256) colors then the color ramps are replaced with a palette of color cells.

You can set the size of these cells by calling the SetCellSize() method.

Constructor & Destructor Documentation

BColorControl::BColorControl	(	BPoint	leftTop,
		color_control_layout	layout,
		float	cellSize,
		const char *	name,
		BMessage *	message = `NULL`,
		bool	bufferedDrawing = `false`
	)

Constructs a new color control object.

Parameters:

leftTop	location of the left top corner of the frame rectangle relative to the parent view.
layout	The layout of the BColorControl. See the color_control_layout enum for more information. Color control layout options include: `B_CELLS_4x64` `B_CELLS_8x32` `B_CELLS_16x16` `B_CELLS_32x8` `B_CELLS_32x8`
cellSize	The size of the sides of the color cell.
name	The name of the color control.
message	The optional message to send to a target in response to a change in color value.
bufferedDrawing	If `true`, all on-screen changes are first made to an off-screen bitmap and then copied to the screen making the drawing smoother, but requiring more memory (currently unused).

BColorControl::BColorControl ( BMessage * archive )

Constructs a BColorControl object from an archive 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 archive deep, the BColorControl object will also unarchive each of its child views recursively.

Parameters:

archive The archive message to restore from.

Member Function Documentation

void BHandler::AddFilter ( BMessageFilter * filter ) [virtual, inherited]

Add filter as a prerequisite to this handler.

If the handler is associated with a looper, this looper needs to be locked in order for this operation to succeed.

Note that the filter is not copied, rather a pointer to the filter is stored. As such, you need to make sure that the filter object exists as long as it is added to this handler.

See also:: RemoveFilter(), SetFilterList()

virtual status_t BView::AllArchived ( BMessage * into ) const [virtual, inherited]

Method relating to the use of BArchiver.

This hook function is called once the first BArchiver that was created in an archiving session is either destroyed, or has its Finish() method called. Implementations of this method can be used, in conjunction with BArchiver::IsArchived(), to reference objects in your archive that you do not own, depending on whether or not those objects were archived by their owners. Implementations of this method should call the implementation of their parent class, the same as for the Archive() method.

Warning:: To guarantee that your AllArchived() method will be called during archival, you must create a BArchiver object in your Archive() implementation.; You should archive any objects you own in your Archive() method implementation, and NOT your AllArchived() method.

See also:: BArchiver BArchiver::Finish()

Reimplemented from BArchivable.

virtual void BColorControl::AllAttached ( ) [virtual]

Similar to AttachedToWindow() but this method is triggered after all child views have already been attached to a window.

See also:: BView::AllAttached()

Reimplemented from BControl.

virtual void BColorControl::AllDetached ( ) [virtual]

Similar to AttachedToWindow() but this method is triggered after all child views have already been detached from a window.

See also:: BView::AllDetached()

Reimplemented from BControl.

virtual status_t BView::AllUnarchived ( const BMessage * archive ) [virtual, inherited]

Method relating to the use of BUnarchiver.

This hook function is called triggered in the BUnarchiver::Finish() method. In this method, you can rebuild references to objects that may be direct children of your object, or may be children of other objects. Implementations of this method should call the implementation of their parent class, the same as for the Archive() method.

Warning:: To guarantee that your AllUnarchived() method will be called during unarchival, you must create a BUnarchiver object in your archive constructor.

See also:: BUnarchiver, BUnarchiver::Finish()

Reimplemented from BArchivable.

virtual status_t BColorControl::Archive	(	BMessage *	archive,
		bool	deep = `true`
	)		const `[virtual]`

Archives the object into archive.

Parameters:

archive	The target archive that the data will go into.
deep	Whether or not to recursively archive child views.

Return values:

B_OK	The archive operation was successful.
B_BAD_VALUE	`NULL` archive message.
B_ERROR	The archive operation failed.

See also:: BArchivable::Archive()

Reimplemented from BControl.

void BColorControl::AttachedToWindow ( ) [virtual]

Hook method that is called when the object is attached to a window.

This method also sets the view color and low color of the color control to be the same as its parent's view color and sets the red, green, and blue BTextControl color values.

See also:: BControl::AttachedToWindow(); BView::SetViewColor()

Reimplemented from BControl.

float BColorControl::CellSize ( ) const

Get the current color cell size.

Returns:: the current color cell size as a float.

void BColorControl::DetachedFromWindow ( ) [virtual]

Hook method that is called when the object is detached from a window.

See also:: BView::DetachedFromWindow()

Reimplemented from BControl.

void BColorControl::Draw ( BRect updateRect ) [virtual]

Draws the area of the color control that intersects updateRect.

Note:: This is an hook method called by the Interface Kit, you don't have to call it yourself. If you need to forcefully redraw the color control consider calling Invalidate() instead.

Parameters:

updateRect The area to be drawn.

See also:: BView::Draw()

Reimplemented from BView.

void BView::DrawAfterChildren ( BRect r ) [virtual, inherited]

Perform any drawing that needs to be done after child view have already been drawn.

Parameters:

r	The rectangular area to be drawn.

BList * BHandler::FilterList ( ) [inherited]

Return a pointer to the list of filters.

Returns:: A pointer to the list of filters. Do not manipulate the list of filters directly, but use the methods provided by this class, in order to maintain internal consistency.

See also:: AddFilter(), RemoveFilter(), SetFilterList().

void BColorControl::FrameMoved ( BPoint new_position ) [virtual]

Hook method that gets called when the color control is moved.

Parameters:

new_position The point that the top left corner of the frame is moved to.

See also:: BView::FrameMoved()

Reimplemented from BView.

void BColorControl::FrameResized	(	float	new_width,
		float	new_height
	)		`[virtual]`

Hook method that gets called when the checkbox is resized.

Parameters:

new_width	The new width of the checkbox.
new_height	The new height of the checkbox.

See also:: BView::FrameResized()

Reimplemented from BView.

BLayout * BView::GetLayout ( ) const [inherited]

Get the layout of the view.

Returns:: The layout of the view.

void BColorControl::GetPreferredSize	(	float *	_width,
		float *	_height
	)		`[virtual]`

Fill out the preferred width and height of the checkbox into the _width and _height parameters.

Parameters:

_width	Pointer to a `float` to hold the width of the checkbox.
_height	Pointer to a `float` to hold the height of the checkbox.

See also:: BView::GetPreferredSize()

Reimplemented from BControl.

virtual status_t BColorControl::GetSupportedSuites ( BMessage * message ) [virtual]

Report the suites of understood messages.

See also:: BHandler::GetSupportedSuites();

Reimplemented from BControl.

static BArchivable* BColorControl::Instantiate ( BMessage * archive ) [static]

Creates a new object from an archive.

If the message is a valid object then the instance created from the passed in archive will be returned. Otherwise this method will return NULL.

Parameters:

archive The archive message.

Returns:: An instance of the object if archive is valid or NULL.

See also:: BArchivable::Instantiate()

Reimplemented from BControl.

status_t BColorControl::Invoke ( BMessage * msg = NULL ) [virtual]

Tells the messenger to send a message.

Parameters:

msg	The message to send.

See also:: BControl::Invoke()

Reimplemented from BControl.

bool BControl::IsEnabled ( ) const [inherited]

Gets whether or not the control is currently enabled.

Returns:: true if the control is enabled, false if it is disabled.

virtual void BColorControl::KeyDown	(	const char *	bytes,
		int32	numBytes
	)		`[virtual]`

Hook method that is called when a keyboard key is pressed.

Overrides BView::KeyDown() to toggle the control value and then calls Invoke() for B_SPACE or B_ENTER. If this is not desired you should override this method in derived classes.

The KeyDown() method is only called if the BControl is the focus view in the active window. If the window has a default button, B_ENTER will be passed to that object instead of the focus view.

Parameters:

bytes	The bytes of the key combination pressed.
numBytes	The number of bytes in bytes.

See also:: BView::KeyDown(); MakeFocus()

Reimplemented from BControl.

void BView::KeyUp	(	const char *	bytes,
		int32	numBytes
	)		`[virtual, inherited]`

Hook method that is called when a keyboard key is released.

Parameters:

bytes	The bytes of the key combination pressed.
numBytes	The number of bytes in bytes.

const char * BControl::Label ( ) const [inherited]

Gets the label of the control.

returns The control's label.

color_control_layout BColorControl::Layout ( ) const

Get the current color control layout.

Returns:: The current color_control_layout

void BLayout::LayoutInvalidated ( bool descendants = false ) [protected, virtual, inherited]

Hook method called when this layout becomes invalid. This is a good place to clear any caches your object might hold.

Reimplemented in BTextView, BScrollView, BBox, BButton, and BCheckBox.

bool BHandler::LockLooper ( ) [inherited]

Lock the looper associated with this handler.

Return values:

true	The looper is locked.
false	There was an error acquiring the lock.

See also:: LockLooperWithTimeout(), UnlockLooper()

status_t BHandler::LockLooperWithTimeout ( bigtime_t timeout ) [inherited]

Lock the looper associated with this handler, with a time out value.

Parameters:

timeout The time to wait for acquiring the lock in microseconds. You may also use B_INFINITE_TIMEOUT, in which this method will wait as long as it takes to acquire the lock.

Return values:

B_OK	Locking succeeded.
B_BAD_VALUE	This handler is not associated with a looper (anymore).
B_TIMED_OUT	The time specified in timeout has passed without locking the looper.

See also:: LockLooper(), UnlockLooper()

BLooper * BHandler::Looper ( ) const [inherited]

Return a pointer to the looper that this handler is associated with.

Returns:: If the handler is not yet associated with a looper, it will return NULL.

See also:: BLooper::AddHandler(); LockLooper()

void BColorControl::MakeFocus ( bool state = true ) [virtual]

Gives focus to or removes focus from the color control.

Parameters:

state true to set focus, false to remove it.

See also:: BControl::MakeFocus()

Reimplemented from BControl.

BSize BView::MaxSize ( ) [virtual, inherited]

Get the maximum size of the view.

Returns:: The maximum size of the view as a BSize.

See also:: BAbstractLayout::MaxSize()

Reimplemented in BTextView, BBox, BListView, BButton, BCheckBox, and BScrollView.

virtual void BColorControl::MessageReceived ( BMessage * message ) [virtual]

Handle message that has been received by the associated looper.

This method is reimplemented by subclasses. If the messages that have been received by a looper pass through the filters, then they end up in the MessageReceived() methods.

The example below shows a very common way to handle message. Usually, this involves parsing the BMessage::what constant and then perform an action based on that.

void
ShowImageApp::MessageReceived(BMessage *message)
{
    switch (message->what) {
        case MSG_FILE_OPEN:
            fOpenPanel->Show();
            break;

        case B_CANCEL:
            // File open panel was closed,
            // start checking count of open windows.
            StartPulse();
            break;
        
        default:
            // We do not handle this message, pass it on to the base class.
            BApplication::MessageReceived(message); 
            break;
    }
}

If your handler cannot process this message, you should pass it on to the base class. Eventually, it will reach the base implementation, which will reply with B_MESSAGE_NOT_UNDERSTOOD.

Attention:: If you want to keep or manipulate the message, have a look at BLooper::DetachCurrentMessage() to receive ownership of the message.

Parameters:

message The message that needs to be handled.

Reimplemented from BControl.

BSize BView::MinSize ( ) [virtual, inherited]

Get the minimum size of the view.

Returns:: The minimum size of the view as a BSize.

See also:: BAbstractLayout::MinSize()

Reimplemented in BTextView, BBox, BListView, BButton, BCheckBox, and BScrollView.

virtual void BColorControl::MouseDown ( BPoint point ) [virtual]

Hook method that is called when a mouse button is pressed.

Parameters:

point The point on the screen where to mouse pointer is when the mouse button is pressed.

See also:: BView::MouseDown()

Reimplemented from BControl.

virtual void BColorControl::MouseMoved	(	BPoint	point,
		uint32	transit,
		const BMessage *	message
	)		`[virtual]`

Hook method that is called when the mouse is moved.

See also:: BView::MouseMoved()

Reimplemented from BControl.

virtual void BColorControl::MouseUp ( BPoint point ) [virtual]

Hook method that is called when a mouse button is released.

Parameters:

point The point on the screen where to mouse pointer is when the mouse button is released.

See also:: BView::MouseUp()

Reimplemented from BControl.

const char * BHandler::Name ( ) const [inherited]

Return the name of this handler.

See also:: SetName()

BHandler * BHandler::NextHandler ( ) const [inherited]

Return the next hander in the chain to which the message is passed on.

See also:: SetNextHandler()

BSize BView::PreferredSize ( ) [virtual, inherited]

Get the preferred size of the view.

Returns:: The preferred size of the view as a BSize.

See also:: BAbstractLayout::PreferredSize()

Reimplemented in BTextView, BBox, BListView, BButton, BCheckBox, and BScrollView.

void BView::Pulse ( ) [virtual, inherited]

Hook method that gets invoked when the view receives a B_PULSE message.

An action is performed each time the App Server calls the Pulse() method. The pulse rate is set by SetPulseRate(). You can implement Pulse() to do anything you want. The default version does nothing. The pulse granularity is no better than once per 100,000 microseconds.

See also:: SetPulseRate()

Reimplemented in BTextView.

bool BHandler::RemoveFilter ( BMessageFilter * filter ) [virtual, inherited]

Remove filter from the filter list.

If the handler is associated with a looper, this looper needs to be locked in order for this operation to succeed.

Note that the filter is not deleted, merely removed from the list. You need to take care of the memory yourself.

Return values:

true	The filter was in the filter list and is removed.
false	The filter was not found in the filter list.

See also:: AddFilter(), FilterList()

void BColorControl::ResizeToPreferred ( ) [virtual]

Resize the color control to its preferred size.

See also:: BView::ResizeToPreferred()

Reimplemented from BControl.

virtual BHandler* BColorControl::ResolveSpecifier	(	BMessage *	message,
		int32	index,
		BMessage *	specifier,
		int32	what,
		const char *	property
	)		`[virtual]`

Determine the proper specifier for scripting messages.

See also:: BHandler::ResolveSpecifier()

Reimplemented from BControl.

void BHandler::SendNotices	(	uint32	what,
		const BMessage *	msg = `NULL`
	)		`[virtual, inherited]`

Emit a state change to the observers.

The actual state (specified by what) will not be transmitted. This is merely for internal bookkeeping. It is not entirely unimaginable that you still want to inform the observers of what actually took place. You can use the msg to transmit this, and any other data you want. Note that the message will be copied and slightly altered: the what member of the message will be B_OBSERVER_NOTICE_CHANGE, and the what constant you specified will be stored in the B_OBSERVE_ORIGINAL_WHAT label.

Parameters:

what	The identifier of the state.
msg	Any data associated with the state change. You retain ownership of this data, so make sure you dispose it when you are done.

void BColorControl::SetCellSize ( float cellSide ) [virtual]

Set the size of the color cell in the color control.

Parameters:

cellSide The cell size to set.

void BColorControl::SetEnabled ( bool enabled ) [virtual]

Enable and disable the color control.

Parameters:

enabled Whether to enable or disable the color control.

Reimplemented from BControl.

void BView::SetExplicitAlignment ( BAlignment alignment ) [inherited]

Set this item's explicit alignment, to be used by Alignment().

See also:: BAbstractLayout::SetExplicitAlignment()

void BView::SetExplicitMaxSize ( BSize size ) [inherited]

Set this item's explicit max size, to be used by MaxSize().

See also:: BAbstractLayout::SetExplicitMaxSize()

void BView::SetExplicitMinSize ( BSize size ) [inherited]

Set this item's explicit min size, to be used by MinSize().

See also:: BAbstractLayout::SetExplicitMinSize()

void BView::SetExplicitPreferredSize ( BSize size ) [inherited]

Set this item's explicit preferred size, to be used by PreferredSize().

See also:: BAbstractLayout::SetExplicitPreferredSize()

void BHandler::SetFilterList ( BList * filters ) [virtual, inherited]

Set the internal list of filters to filters.

If the handler is associated with a looper, this looper needs to be locked in order for this operation to succeed.

The internal list will be replaced with the new list of filters. All the existing filters will be deleted.

See also:: AddFilter(), FilterList()

void BControl::SetLabel ( const char * label ) [virtual, inherited]

Sets the label of the control.

If the label changes the control is redrawn.

Parameters:

label The label to set, can be NULL.

Reimplemented in BButton.

void BColorControl::SetLayout ( BLayout * layout ) [virtual]

Set the layout of the BColorControl object to layout.

Parameters:

layout The layout to set.

See also:: BView::SetLayout()

Reimplemented from BView.

void BColorControl::SetLayout ( color_control_layout layout ) [virtual]

Set the layout of the color control.

Color control layout options include:

B_CELLS_4x64
B_CELLS_8x32
B_CELLS_16x16
B_CELLS_32x8
B_CELLS_32x8

Parameters:

layout The color control layout to set.

void BHandler::SetName ( const char * name ) [inherited]

Set or change the name of this handler.

See also:: Name()

void BHandler::SetNextHandler ( BHandler * handler ) [virtual, inherited]

Set the next handler in the chain that the message is passed on to if this handler cannot process it.

This method has three requirements:

This handler should belong to a looper.
The looper needs to be locked. See LockLooper().
The handler that you pass must be associated with the same looper.

Failure to meet any of these requirements will result in your application crashing.

By default, the handlers are chained in order that they were associated to a looper with BLooper::AddHander().

See also:: NextHandler()

void BColorControl::SetValue ( int32 value ) [virtual]

Set the color of the BColorControl to value.

Parameters:

value The 32-bit color value to set.

Reimplemented from BControl.

Referenced by SetValue().

void BColorControl::SetValue ( rgb_color color ) [inline]

Set the color of the BColorControl to color.

Parameters:

color The rgb_color to set.

References SetValue().

void BControl::SetValueNoUpdate ( int32 value ) [protected, inherited]

Sets the value of the control without redrawing.

Parameters:

value The value to set.

See also:: SetValue()

status_t BHandler::StartWatching	(	BMessenger	target,
		uint32	what
	)		`[inherited]`

Subscribe this handler to watch a specific state change of a target.

Use this method to subscribe messengers to watch state changes in this handler, this also means that observers from other teams can be subscribed.

// Handler B watches Handler A
BHandler A, B;
BMessenger messengerA(&A)

B.StartWatching(messengerA, kNetworkConnection);

Parameters:

target	The messenger from which the notifications would be received.
what	The state that needs to be watched.

Returns:: During the call of this method, a notification will be transmitted using the target. If this works, then this method will return B_OK.

See also:: StartWatchingAll(BMessenger), StopWatching(BMessenger, uint32)

status_t BHandler::StartWatching	(	BHandler *	observer,
		uint32	what
	)		`[inherited]`

Subscribe an observer for a specific state change of this handler.

Use this method to subscribe observers to watch this handler. State changes of this handler that match the what argument, will be sent.

// Handler B wants to observe Handler A
BHandler A, B;

A.StartWatching(&B, kNetworkConnection);

Since pointers to handlers can only exist in the local namespace, have a look at StartWatching(BMessenger, uint32) for inter-team watching.

Parameters:

observer	The observer for this handler.
what	The state that needs to be watched.

Returns:: During the call of this method, a notification will be transmitted using the observer. If this works, then this method will return B_OK.

See also:: StartWatchingAll(BHandler*), StopWatching(BHandler*, uint32)

status_t BHandler::StartWatchingAll ( BMessenger target ) [inherited]

Subscribe this handler to watch a target for all events.

This method performs the same task as StartWatching(BMessenger, uint32), but it will subscribe to all the state changes the target knows.

See also:: StartWatching(BMessenger, uint32), StopWatchingAll(BMessenger)

status_t BHandler::StartWatchingAll ( BHandler * observer ) [inherited]

Subscribe an observer for a all state changes.

This method performs the same task as StartWatching(BHandler, uint32), but it will subscribe the observer to all the state changes this handler tracks.