Class PenRefUI

GEOS-SC:  Library demoui_lib: Class PenRefUI


This class contains utility functions that pertain to the UI for a specific project.

#include <flexui/penrefui.h>


Class Data and Methods

public:
enum PenRefComponentType;
static Boolean ValidateLook(PenRefComponentType type, LookHint lookHint);
static void GetValidLooks(PenRefComponentType type, const LookHint **lookHintArray, uint16 *lookHintCount);
protected:

Inherited Data and Methods:

This class does not inherit from any other class.

Back to the top of PenRefUI


Ancestors

This class does not inherit from any other class.

Back to the top of PenRefUI


Descendants

Class is not inherited by any others.

Back to the top of PenRefUI


OVERVIEW

ValidateLookFunction() checks if a look value is legal for a certain PenRefUI component. GetValidLooks returns an array of valid look values for a certain PenRefUI component.

Back to the top of PenRefUI


Descriptions of Class Data and Methods


enum PenRefComponentType;

PenRefComponentType to indicate which components LookHint information to retrieve.

PRCT_BUTTON
Specifies Button
PRCT_CHECKBOX
Specifies Checkbox
PRCT_DIALOG
Specifies Dialog
PRCT_FRAME
Specifies Frame
PRCT_IMAGE
Specifies Image
PRCT_INK
Specifies Ink
PRCT_LABEL
Specifies Label
PRCT_LIST
Specifies List
PRCT_MENU
Specifies Menu
PRCT_MENU_BUTTON
Specifies MenuButton
PRCT_PANEL
Specifies Panel
PRCT_HORIZONTAL_PANEL
Specifies Horizontal Panel
PRCT_VERTICAL_PANEL
Specifies Vertical Panel
PRCT_SCROLLBAR
Specifies Scrollbar
PRCT_SCROLLPANE
Specified Scrollpane
PRCT_TABLE
Specifies Table
PRCT_TEXT_AREA
Specifies TextArea
PRCT_TEXT_FIELD
Specifies Textfield

Declared as:

    enum PenRefComponentType {
        PRCT_BUTTON,
        PRCT_CHECKBOX,
        PRCT_DIALOG,
        PRCT_FRAME,
        PRCT_IMAGE,
        PRCT_INK,
        PRCT_LABEL,
        PRCT_LIST,
        PRCT_MENU,
        PRCT_MENU_BUTTON,
        PRCT_PANEL,
        PRCT_HORIZONTAL_PANEL,
        PRCT_VERTICAL_PANEL,
        PRCT_SCROLLBAR,
        PRCT_SCROLLPANE,
        PRCT_TABLE,
        PRCT_TEXTAREA,
        PRCT_TEXTFIELD,
        PRCT_NUM_COMPONENTS
    };

Back to the top of PenRefUI


Boolean ValidateLook(PenRefComponentType type, LookHint lookHint);

Validate the look value against valid look values for the specified PenRefUI component. This function is meant only for EC code.

Parameters:

in type
PenRefComponentType to indicate which PenRefUI component to validate against the passed look. value.
in lookHint
LookHint value to validate against the PenRefUI component. Return value: TRUE if the look passed in is valid for the specified PenRefUI component

Prototype:

    static Boolean ValidateLook(PenRefComponentType type, LookHint lookHint);

Back to the top of PenRefUI


void GetValidLooks(PenRefComponentType type, const LookHint **lookHintArray, uint16 *lookHintCount);

Get an array of the valid looks for a PenRefUI component. This is useful if you want to run tests on all the valid looks for a component. This method is for EC code or DEBUG_AID code

Parameters:

in type
PenRefComponentType to specify which PenRefUI component to find the valid looks.

out lookHintArray
Returns an array of valid looks for the specified PenRefUI component.
out lookHintCount
Returns the number of looks in the returned array.

Return value: void

See also:

Prototype:

    static void GetValidLooks(PenRefComponentType type, 
                              const LookHint **lookHintArray,
                              uint16 *lookHintCount);

Back to the top of PenRefUI


Generated from source by Geoworks on Sat Dec 12 18:29:30 1998 .