WPColorPalette

Class definition file: wpclrpal.idl

Class hierarchy SOMObject
WPObject
WPAbstract
WPPalette
WPColorPalette

Description

This is the color palette object class. An instance of this class can be created as a Workplace object. Two instances of this class are created initially by the system, with the titles "Mixed Color Palette" and "Solid Color Palette", both residing in the "System Setup" folder.

Instance methods

There are currently no methods defined for the WPColorPalette Workplace object class.

SOMObject instance methods

The following list shows all the instance methods overridden by the WPObject class. These instance methods are overridden in order to modify the behavior defined by an ancestor class.

• somDefaultInit
  
• somDestruct

WPObject instance methods

The following list shows all the methods overridden by the WPColorPalette class. These methods are overridden in order to modify the behavior defined by an ancestor class.

• wpInitData 
  wpMenuItemHelpSelected
  
  wpSetup

  wpSetup override by WPColorPalette

  The following table shows the keyname-value pairs added by the WPColorPalette class.

  ┌──────────┬──────────┬────────────────────────────────────────┐│KEYNAME   │VALUE     │DESCRIPTION                             │
  ├──────────┼──────────┼────────────────────────────────────────┤
  │AUTOSETUP │HIRES     │This sets the number of default colors  │
  │          │          │in the color palette to the 256-color   │
  │          │          │Mixed Color Palette.                    │
  ├──────────┼──────────┼────────────────────────────────────────┤
  │          │LORES     │This sets the number of default colors  │
  │          │          │in the color palette to the 16-color    │
  │          │          │Solid Color Palette.                    │
  ├──────────┼──────────┼────────────────────────────────────────┤
  │COLORS    │RGB values│These are the initial color values of   │
  │          │          │each cell in the color palette. The     │
  │          │          │values for each cell are separated by   │
  │          │          │commas. This is equivalent to calling   │
  │          │          │the wpSetupCell method. The RGB value   │
  │          │          │must be presented as a 6-digit hex value│
  │          │          │in the format 0xRRGGBB where RR, GG, and│
  │          │          │BB are the red, green, and blue, values │
  │          │          │ranging between 0x00 and 0xFF (0-255).  │
  ├──────────┼──────────┼────────────────────────────────────────┤
  │XCELLCOUNT│columns   │Number of X cells as decimal digits.    │
  │          │          │For Solid Color Palette, AUTOSETUP=LORES│
  │          │          │must be specified, and the default value│
  │          │          │is 8.                                   │
  │          │          │For Mixed Color Palette, AUTOSETUP=HIRES│
  │          │          │must be specified, and the default value│
  │          │          │is 16.                                  │
  ├──────────┼──────────┼────────────────────────────────────────┤
  │YCELLCOUNT│rows      │Number of Y cells as decimal digits.    │
  │          │          │For Solid Color Palette, AUTOSETUP=LORES│
  │          │          │must be specified, and the default value│
  │          │          │is 2.                                   │
  │          │          │For Mixed Color Palette, AUTOSETUP=HIRES│
  │          │          │must be specified, and the default value│
  │          │          │is 16.                                  │
  └──────────┴──────────┴────────────────────────────────────────┘
  

  Example

  pszSetupString="COLORS=0x000000,"
                        "0xFFFFFF,"
                        "0xFF23B4,"
                        "0x505050,"
                        "0x00FFFF,"
                        "0xA0A0A0";
  

  WPPalette methods

  The following list shows all the methods overridden by the WPColorPalette class. These methods are overridden in order to modify the behavior defined by an ancestor class.

  • wpDragCell
    
  • wpEditCell
    
  • wpPaintCell
    
  • wpQueryPaletteHelp
    
  • wpSelectCell

  Class methods

  There are currently no class methods defined for the WPColorPalette Workplace object class.

  WPObject class methods

  The following list shows all the class methods overridden by the WPColorPalette class. These methods are overridden to modify the behavior defined by an ancestor class.

  • wpclsCreateDefaultTemplates 
    wpclsQueryDefaultHelp
    
    wpclsQueryIconData
    
    wpclsQueryStyle
    
    wpclsQueryTitle

    WPPalette class methods

    The following list shows all the class methods overridden by the WPColorPalette class. These methods are overridden to modify the behavior defined by an ancestor class.

    • wpclsQueryEditString

    ---

    [Back: WPClock]
    [Next: WPCommandFile]