Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::UIShellPeer

VCF::UIShellPeer Class Reference

Class UIShellPeer interface documentation. More...

#include <vcf/ApplicationKit/UIShellPeer.h>

Inheritance diagram for VCF::UIShellPeer:

VCF::Interface VCF::OSXUIShellPeer VCF::Win32UIShell VCF::XCBUIShellPeer List of all members.

Public Member Functions

virtual ~UIShellPeer ()
virtual void shellBeginPainting (Rect *clippingRect)=0
 Prepares the shell for painting.
virtual void shellEndPainting ()=0
 called after finished painting on the shell allows for native Windowing system cleanup to happen
virtual bool shellSupportsVirtualDirectories ()=0
virtual bool shellHasFileSystemDirectory ()=0
virtual String shellGetDirectory ()=0
virtual OSHandleID shellGetHandleID ()=0
virtual OSHandleID shellGetGraphicsContextHandleID ()=0
virtual void shellSetUIShell (UIShell *shell)=0
virtual uint32 shellGetWidth ()=0
virtual uint32 shellGetHeight ()=0
virtual Rect shellGetUsableBounds ()=0
virtual Point getCurrentMousePosition ()=0
virtual void performFileOp (int operationType, const std::vector< String > &srcFiles, const std::vector< String > &destFiles)=0
virtual void launch (const String &fileName, const String &parameters)=0
virtual void openTrash ()=0
virtual void emptyTrash ()=0
virtual void createFileShortcut (const String &originalFileName, const String &shortcutFileName)=0
virtual MIMEType getMIMEType (const String &fileName)=0
virtual void createFileAssociation (const FileAssociationInfo &info, bool forAllUsers)=0
virtual void removeFileAssociation (const FileAssociationInfo &info, bool forAllUsers)=0

Detailed Description

Class UIShellPeer interface documentation.

Constructor & Destructor Documentation

virtual VCF::UIShellPeer::~UIShellPeer (   )  [inline, virtual]
 

Member Function Documentation

virtual void VCF::UIShellPeer::createFileAssociation (  const FileAssociationInfo &  info,
bool  forAllUsers
)  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, and VCF::Win32UIShell.

virtual void VCF::UIShellPeer::createFileShortcut (  const String &  originalFileName,
const String &  shortcutFileName
)  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, and VCF::Win32UIShell.

virtual void VCF::UIShellPeer::emptyTrash (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, and VCF::Win32UIShell.

virtual Point VCF::UIShellPeer::getCurrentMousePosition (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual MIMEType VCF::UIShellPeer::getMIMEType (  const String &  fileName  )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, and VCF::Win32UIShell.

virtual void VCF::UIShellPeer::launch (  const String &  fileName,
const String &  parameters
)  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, and VCF::Win32UIShell.

virtual void VCF::UIShellPeer::openTrash (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, and VCF::Win32UIShell.

virtual void VCF::UIShellPeer::performFileOp (  int  operationType,
const std::vector< String > &  srcFiles,
const std::vector< String > &  destFiles
)  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, and VCF::Win32UIShell.

virtual void VCF::UIShellPeer::removeFileAssociation (  const FileAssociationInfo &  info,
bool  forAllUsers
)  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, and VCF::Win32UIShell.

virtual void VCF::UIShellPeer::shellBeginPainting (  Rect *  clippingRect  )  [pure virtual]
 

Prepares the shell for painting.

MUST be called before calling getContext(), or errors may occur

Parameters:
Rect* specifies a rectangular region to clip the drawing to. The rectangles coords are screen coords.

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual void VCF::UIShellPeer::shellEndPainting (   )  [pure virtual]
 

called after finished painting on the shell allows for native Windowing system cleanup to happen

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual String VCF::UIShellPeer::shellGetDirectory (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual OSHandleID VCF::UIShellPeer::shellGetGraphicsContextHandleID (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual OSHandleID VCF::UIShellPeer::shellGetHandleID (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual uint32 VCF::UIShellPeer::shellGetHeight (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual Rect VCF::UIShellPeer::shellGetUsableBounds (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual uint32 VCF::UIShellPeer::shellGetWidth (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual bool VCF::UIShellPeer::shellHasFileSystemDirectory (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual void VCF::UIShellPeer::shellSetUIShell (  UIShell *  shell  )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

virtual bool VCF::UIShellPeer::shellSupportsVirtualDirectories (   )  [pure virtual]
 

Implemented in VCF::OSXUIShellPeer, VCF::Win32UIShell, and VCF::XCBUIShellPeer.

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information