ICommandPanel Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class FPStaticInterface, Class Interface

Description:

This class is available in release 4.0 and later only.

This class represents the interface to the Command Panel. You can obtain a pointer to the Command Panel interface using; ICommandPanel* GetICommandPanel(). This macro will return

(ICommandPanel*)GetCOREInterface(COMMAND_PANEL_INTERFACE).

All methods of this class are Implemented by the System.

#include <icommandpanel.h>

Inheritance diagram for ICommandPanel:

List of all members.

Public Types
enum	{ fnIdGetRollupThreshhold, fnIdSetRollupThreshhold }
Public Member Functions
virtual int	GetRollupThreshold ()=0
virtual void	SetRollupThreshold (int iThresh)=0

---

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

fnIdGetRollupThreshhold	Search for all occurrences
fnIdSetRollupThreshhold	Search for all occurrences

         { 
           fnIdGetRollupThreshhold,
           fnIdSetRollupThreshhold,
    };

---

Member Function Documentation

virtual int GetRollupThreshold

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method returns the command panel's rollup threshold.

The threshold (which defaults to 50 pixels) affects the way rollups are placed when the command panel is resized (from one to multiple columns). A number of rollups remain in the left column while others move over to the second and/or additional columns based on this. A lower threshold will increase the likelihood that a panel gets shifted over to the next column.

virtual void SetRollupThreshold

(

int

iThresh

)

[pure virtual]

Search for all occurrences

Remarks:

This method allows you to set the command panel's rollup threshold.

Parameters:

int iThresh

The threshold you wish to set, in pixels