Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

BarToolButton Class Reference

#include <bars.h>

Inheritance diagram for BarToolButton:

BarControlBase BarItem ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

 BarToolButton ()
 Inits BarToolButton member vars.
BOOL Read (CCLexFile &)
BOOL Write (CCLexFile &)
virtual BOOL Read (String_256 *)
virtual BOOL Write (String_256 *)
UINT32 GetToolID ()
void SetToolID (UINT32 ThisToolID)
UINT32 GetBubbleID (BOOL)
 In derived classes will return the bubble help resource string currently associated with the control. In the base class an ENSURE occurs.
void SetBubbleID (UINT32 Id)
UINT32 GetStatusID (BOOL)
void SetStatusID (UINT32 Id)
UINT32 GetBitmap (BitmapType Type)
 Lets you get hold of the bitmaps within a BarToolButton.
void SetBitmap (BitmapType Type, UINT32 ThisBitmap)
 Lets you set the bitmap IDs within a BarToolButton.

Private Attributes

UINT32 ToolID
UINT32 Bitmap
UINT32 BitmapActive
UINT32 BubbleID
UINT32 StatusID

Detailed Description

Definition at line 331 of file bars.h.

Constructor & Destructor Documentation

BarToolButton::BarToolButton (   ) 
 

Inits BarToolButton member vars.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
25/5/94
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Definition at line 4511 of file bars.cpp.

04512 {
04513     ToolID          = 0;
04514     Bitmap          = 0;
04515     BitmapActive    = 0;
04516     BubbleID        = 0;
04517     StatusID        = 0;
04518 }

Member Function Documentation

UINT32 BarToolButton::GetBitmap (  BitmapType  Type  ) 
 

Lets you get hold of the bitmaps within a BarToolButton.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
10/5/94
Parameters:
Type = the type of bitmap you want (Active or Inactive) [INPUTS]
- [OUTPUTS]
Returns:
The Bitmap ID of the desired bitmap

Errors: -

See also:
-

Definition at line 4536 of file bars.cpp.

04537 { 
04538     if (Type == Active) 
04539         return BitmapActive; 
04540     else
04541         return Bitmap;
04542 }

UINT32 BarToolButton::GetBubbleID (  BOOL   )  [inline, virtual]
 

In derived classes will return the bubble help resource string currently associated with the control. In the base class an ENSURE occurs.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
19/5/94
Parameters:
Horz,: The orientation of the bar [INPUTS]
The controls current BubbleID [OUTPUTS]
Returns:
Bubble help resource string associated with the control

Errors: -

See also:
-

Reimplemented from BarControlBase.

Definition at line 353 of file bars.h.

00353 { return BubbleID;}

UINT32 BarToolButton::GetStatusID (  BOOL   )  [inline, virtual]
 

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
19/5/94
Parameters:
Horz,: The orientation of the bar [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Reimplemented from BarControlBase.

Definition at line 356 of file bars.h.

00356 { return StatusID; }

UINT32 BarToolButton::GetToolID (   )  [inline]
 

Definition at line 349 of file bars.h.

00349 { return ToolID; }

virtual BOOL BarToolButton::Read (  String_256 *   )  [inline, virtual]
 

Implements BarItem.

Definition at line 346 of file bars.h.

00346 { return TRUE; }

BOOL BarToolButton::Read (  CCLexFile &   )  [inline, virtual]
 

Implements BarItem.

Definition at line 342 of file bars.h.

00342 { return TRUE; }

void BarToolButton::SetBitmap (  BitmapType  Type,
UINT32  ThisBitmap
) 
 

Lets you set the bitmap IDs within a BarToolButton.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
10/5/94
Parameters:
Type = the type of bitmap you want to set (Active or Inactive) [INPUTS] ThisBitmap = the bitmap ID you want to set
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Definition at line 4560 of file bars.cpp.

04561 { 
04562     switch (Type)
04563     {
04564         case Active   : BitmapActive = ThisBitmap; break;
04565         case Inactive : Bitmap       = ThisBitmap; break;
04566     }
04567 }

void BarToolButton::SetBubbleID (  UINT32  Id  )  [inline]
 

Definition at line 354 of file bars.h.

00354 { BubbleID = Id;}

void BarToolButton::SetStatusID (  UINT32  Id  )  [inline]
 

Definition at line 357 of file bars.h.

00357 { StatusID  = Id;}

void BarToolButton::SetToolID (  UINT32  ThisToolID  )  [inline]
 

Definition at line 350 of file bars.h.

00350 {ToolID = ThisToolID;}

virtual BOOL BarToolButton::Write (  String_256 *   )  [inline, virtual]
 

Implements BarItem.

Definition at line 347 of file bars.h.

00347 { return TRUE; }

BOOL BarToolButton::Write (  CCLexFile &   )  [inline, virtual]
 

Implements BarItem.

Definition at line 343 of file bars.h.

00343 { return TRUE; }

Member Data Documentation

UINT32 BarToolButton::Bitmap [private]
 

Definition at line 368 of file bars.h.

UINT32 BarToolButton::BitmapActive [private]
 

Definition at line 369 of file bars.h.

UINT32 BarToolButton::BubbleID [private]
 

Definition at line 371 of file bars.h.

UINT32 BarToolButton::StatusID [private]
 

Definition at line 374 of file bars.h.

UINT32 BarToolButton::ToolID [private]
 

Definition at line 363 of file bars.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:50:49 2007 for Camelot by  doxygen 1.4.4